summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--json/account.rst65
-rw-r--r--json/index.rst1
2 files changed, 66 insertions, 0 deletions
diff --git a/json/account.rst b/json/account.rst
new file mode 100644
index 0000000..9e04bcd
--- /dev/null
+++ b/json/account.rst
@@ -0,0 +1,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?
+
diff --git a/json/index.rst b/json/index.rst
index 1de7d13..28767b3 100644
--- a/json/index.rst
+++ b/json/index.rst
@@ -69,6 +69,7 @@ message whereas successful requests carry actual response data in the key
stations
play
bookmarks
+ account
methods
errorcodes
implementations