Commit
- Loading branch information
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -579,49 +579,118 @@ __Arguments__ | |
| --------------------------------------- | ||
| <a name="getThreadList"></a> | ||
| ### api.getThreadList(limit, timestamp, tags, callback) | ||
| Returns information about the user's threads. | ||
| __Arguments__ | ||
| * `limit`: Limit the number of threads to fetch. | ||
| * `timestamp`: Request threads *before* this date. `null` means *now* | ||
| * `tags`: An array describing which folder to fetch. It should be one of these: | ||
| - `["INBOX"]` *(same as `[]`)* | ||
| - `["ARCHIVED"]` | ||
| - `["PENDING"]` | ||
| - `["OTHER"]` | ||
| - `["INBOX", "unread"]` | ||
| - `["ARCHIVED", "unread"]` | ||
| - `["PENDING", "unread"]` | ||
| - `["OTHER", "unread"]` | ||
| *if you find something new, let us know* | ||
| * `callback(err, list)`: Callback called when the query is done (either with an error or with a proper result). `list` is of type _array_ and contains objects with the following properties: | ||
| __Thread list__ | ||
| | Key | Description | | ||
| |----------------------|-------------------------------------------------------------| | ||
| | threadID | ID of the thread | | ||
| | name | The name of the thread | | ||
| | unreadCount | Amount of unread messages in thread | | ||
| | messageCount | Amount of messages in thread | | ||
| | imageSrc | Link to the thread's image or `null` | | ||
| | emoji | The default emoji in thread (classic like is `null`) | | ||
| | color | Thread's message color in `RRGGBB` (default blue is `null`) | | ||
| | nicknames | An array of `{"userid": "1234", "nickname": "John Doe"}` | | ||
| | muteUntil | Timestamp until the mute expires or `null` | | ||
| | participants | An array of participants. See below | | ||
| | adminIDs | An array of thread admin IDs | | ||
| | folder | `INBOX`, `ARCHIVED`, `PENDING` or `OTHER` | | ||
| | isGroup | `true` or `false` | | ||
| | montageThread | `message_thread:000000` or `null` *not yet tested* | | ||
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong. 
ravkr
Author
Owner
|
||
| | reactionsMuteMode | `REACTIONS_NOT_MUTED` or `REACTIONS_MUTED` | | ||
| | mentionsMuteMode | `MENTIONS_NOT_MUTED` or `MENTIONS_MUTED` | | ||
| | isArchived | `true` or `false` | | ||
| | isSubscribed | `true` or `false` | | ||
| | timestamp | timestamp in miliseconds | | ||
| | snippet | Snippet's text message | | ||
| | snippetAttachments | Attachments in snippet | | ||
| | snippetSender | ID of snippet sender | | ||
| | lastMessageTimestamp | timestamp in milliseconds | | ||
| | lastReadTimestamp | timestamp in milliseconds or `null` | | ||
| | cannotReplyReason | `null`, `"RECIPIENTS_NOT_LOADABLE"` or `"BLOCKED"` | | ||
| __`participants` format__ | ||
| `accountType` is one of the following: | ||
| - `"User"` | ||
| - `"Page"` | ||
| - `"UnavailableMessagingActor"` | ||
| - `"ReducedMessagingActor"` | ||
| (*there might be more*) | ||
| | Key | Description | | ||
| |---------------------------|---------------------------------------------------------------| | ||
| | accountType | `"User"` | | ||
| | userID | ID of user | | ||
| | name | Full name of user | | ||
| | shortName | Short name of user (most likely first name) | | ||
| | gender | Either `"MALE"`, `"FEMALE"` or `"NEUTER"` | | ||
| | url | URL of the user's Facebook profile | | ||
| | profilePicture | URL of the profile picture | | ||
| | username | Username of user or `null` | | ||
| | isViewerFriend | Is the user a friend of you? | | ||
| | isMessengerUser | Does the user use Messenger? | | ||
| | isVerified | Is the user verified? (Little blue tick mark) | | ||
| | isMessageBlockedByViewer | Is the user blocking messages from you? | | ||
| | isViewerCoworker | Is the user your coworker? *(not yet tested)* | | ||
| | isEmployee | `null`? *(not yet tested)* | | ||
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong.
ravkr
Author
Owner
|
||
| | Key | Description | | ||
| |---------------------------|---------------------------------------------------------------| | ||
| | accountType | `"Page"` | | ||
| | userID | ID of the page | | ||
| | name | Name of the fanpage | | ||
| | url | URL of the fanpage | | ||
| | profilePicture | URL of the profile picture | | ||
| | username | Username of user or `null` | | ||
| | acceptsMessengerUserFeedback | | | ||
| | isMessengerUser | Does the fanpage use Messenger? | | ||
| | isVerified | Is the fanpage verified? (Little blue tick mark) | | ||
| | isMessengerPlatformBot | Is the fanpage a bot | | ||
| | isMessageBlockedByViewer | Is the fanpage blocking messages from you? | | ||
| | Key | Description | | ||
| |---------------------------|---------------------------------------------------------------| | ||
| | accountType | **1** `"ReducedMessagingActor"` (account requres verification, messages are hidden) or **2** `"UnavailableMessagingActor"` (account disabled/removed) | | ||
| | userID | ID of the user | | ||
| | name | **1** Name of the user or **2** *Facebook User* in user's language | | ||
| | url | `null` | | ||
| | profilePicture | URL of the default Facebook profile picture | | ||
| | username | Username of user or `null` | | ||
| | acceptsMessengerUserFeedback | | | ||
| | isMessageBlockedByViewer | Is the user blocking messages from you? | | ||
| In a case that some account type is not supported, we return just this *but you can't rely on it* and log warning to the console | ||
| | Key | Description | | ||
| |--------------|-------------------------| | ||
| | accountType | type, can be anything | | ||
| | userID | ID of the account | | ||
| | name | Name of the account | | ||
| --------------------------------------- | ||
|
|
||
It returns
nullfor every chat I have on my account