summaryrefslogtreecommitdiff
path: root/json/account.rst
blob: 9e04bcd1fd0bc9e975c22471c71209ec72a5fbae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
Account
=======

.. _settingkeys:

Available settings
------------------

The following settings are currently read/writeable:

.. csv-table::
   :header: Name,Type,Description

   gender,string,``Male`` or ``Female``
   birthYear,int,
   zipCode,string,
   isProfilePrivate,boolean,
   enableComments,boolean,
   emailOptIn,boolean,
   emailComments,boolean,
   emailNewFollowers,boolean,
   isExplicitContentFilterEnabled,boolean,
   isExplicitContentFilterPINProtected,boolean,
   currentUsername,string,
   currentPassword,string,
   newUsername,string,
   newPassword,string,
   facebookAutoShareEnabled,boolean,
   autoShareTrackPlay,boolean,
   autoShareLikes,boolean,
   autoShareFollows,boolean,
   facebookSettingChecksum,boolean,
   userInitiatedChange,boolean,

.. _user-getSettings:

Retrieve settings
-----------------

:Method: user.getSettings

.. csv-table::
   :header: Name,Type,Description

   includeFacebook,boolean,

See :ref:`settingkeys` for return values.

.. _user-changeSettings:

Change settings
---------------

:Method: user.changeSettings

.. csv-table::
   :header: Name,Type,Description

   includeFacebook,boolean,

Additionally keys listed in :ref:`settingkeys` are permitted in the request
body.

.. TODO: response?