Methods
(async, inner) favorites(subdomains, tokens, cookies, options) → {Promise.<favoritesResponseObject>}
Get the contents of the "Frequenly Used" box for your specified user
Parameters:
Name | Type | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
subdomains |
string | Array.<string> |
a single or list of subdomains from which to analyze emoji. Must match respectively to |
||||||||||||||||||||||||||||
tokens |
string | Array.<string> |
a single or list of tokens to add emoji to. Must match respectively to |
||||||||||||||||||||||||||||
cookies |
string | Array.<string> |
a single or list of cookies used to authenticate access to the given subdomain. Must match respectively to |
||||||||||||||||||||||||||||
options |
object |
contains options on what to present Properties
|
- Source:
Example
var favoritesResult = await emojme.favorites('mySubdomain', 'myToken', 'myCookie', {});
console.log(favoritesResult);
// {
// mySubdomain: {
// favoritesResult: {
// user: '{myToken's user}',
// favoriteEmoji: [
// emojiName,
// ...
// ],
// favoriteEmojiAdminList: [
// {emojiName}: {adminList-style emoji object, with additional `usage` value}
// ...
// ],
// }
// }
// }
Type Definitions
favoritesResponseObject :object
The user-specific favorites response object, like other response objects, is organized by input subdomain.
Properties:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
subdomain |
object |
each subdomain passed in to add will appear as a key in the response Properties
|
- Source: