1Padre::Sync(3)        User Contributed Perl Documentation       Padre::Sync(3)
2
3
4

NAME

6       Padre::Sync - Utility functions for handling remote Configuration
7       Syncing
8

DESCRIPTION

10       The "Padre::Sync" class contains logic for communicating with a remote
11       Madre::Sync server. This class interacts with the
12       Padre::Wx::Dialog::Sync class for user interface display.
13

METHODS

15   "new"
16       The constructor returns a new "Padre::Sync" object, but you should
17       normally access it via the main Padre object:
18
19         my $manager = Padre->ide->config_sync;
20
21       First argument should be a Padre object.
22
23   "main"
24       A convenience method to get to the main window.
25
26   "config"
27       A convenience method to get to the config object
28
29   "ua"
30       A convenience method to get to the useragent object
31
32   "register"
33       Attempts to register a user account with the information provided on
34       the Sync server.  Parameters: a list of key value pairs to be
35       interpreted as POST parameters Returns error string if user state is
36       already logged in or serverside error occurs.
37
38   "login"
39       Will log in to remote Sync server using given credentials. State will
40       be updated if login successful.
41
42   "logout"
43       If currently logged in, will log the Sync session out from the server.
44       State will be updated.
45
46   "server_delete"
47       Given a logged in session, will attempt to delete the config currently
48       stored on the Sync server (if one currently exists).  Will fail if not
49       logged in.
50
51   "local_to_server"
52       Given a logged in session, will attempt to place the current local
53       config to the Sync server.
54
55   "server_to_local"
56       Given a logged in session, will replace the local config with what is
57       stored on the server.  TODO: is validation of config before replacement
58       required?
59
60   "english_status"
61       Will return a string explaining current state of Sync dependent on
62       $self->{state}
63

SEE ALSO

65       Padre, Padre::Config
66

68       Copyright 2008-2011 The Padre development team as listed in Padre.pm.
69
70       This program is free software; you can redistribute it and/or modify it
71       under the same terms as Perl 5 itself.
72
73
74
75perl v5.28.0                      2011-08-16                    Padre::Sync(3)
Impressum