Class: Social
Social API is a part of the Dashboard SDK used to access social media related data.
Use global enplug.social object to access these methods.
Methods#
addFacebookPage#
▸ addFacebookPage(feedId, pageId, accessToken): Promise<any>
Parameters#
| Name | Type |
|---|---|
feedId | string |
pageId | string |
accessToken | string |
Returns#
Promise<any>
approveItem#
▸ approveItem(itemId, assetId): Promise<any>
Parameters#
| Name | Type |
|---|---|
itemId | string |
assetId | string |
Returns#
Promise<any>
authInstagram#
▸ authInstagram(accessToken): Promise<any>
Parameters#
| Name | Type |
|---|---|
accessToken | string |
Returns#
Promise<any>
authSlack#
▸ authSlack(verificationCode, redirectUrl): Promise<any>
Parameters#
| Name | Type |
|---|---|
verificationCode | string |
redirectUrl | string |
Returns#
Promise<any>
authenticateSlack#
▸ authenticateSlack(verificationCode, redirectUrl): Promise<any>
Parameters#
| Name | Type |
|---|---|
verificationCode | string |
redirectUrl | string |
Returns#
Promise<any>
authenticateTeamsAdmin#
▸ authenticateTeamsAdmin(tenantId): Promise<any>
Saves Teams Admin token to backend.
Parameters#
| Name | Type | Description |
|---|---|---|
tenantId | string | A user id returned from MS Teams after authenticating. |
Returns#
Promise<any>
authenticateTeamsUser#
▸ authenticateTeamsUser(verificationCode, redirectUrl): Promise<any>
Parameters#
| Name | Type |
|---|---|
verificationCode | string |
redirectUrl | string |
Returns#
Promise<any>
banItem#
▸ banItem(itemId, assetId): Promise<any>
Parameters#
| Name | Type |
|---|---|
itemId | string |
assetId | string |
Returns#
Promise<any>
clearQueryString#
▸ clearQueryString(): Promise<any>
Returns#
Promise<any>
deleteFeed#
▸ deleteFeed(feedId): Promise<any>
Parameters#
| Name | Type |
|---|---|
feedId | string |
Returns#
Promise<any>
favoriteItem#
▸ favoriteItem(itemId, assetId, network): Promise<void>
Parameters#
| Name | Type |
|---|---|
itemId | string |
assetId | string |
network | string |
Returns#
Promise<void>
getFeeds#
▸ getFeeds(assetId): Promise<any>
Parameters#
| Name | Type |
|---|---|
assetId | string |
Returns#
Promise<any>
getInstagramAccounts#
▸ getInstagramAccounts(userId): Promise<any>
Parameters#
| Name | Type |
|---|---|
userId | string |
Returns#
Promise<any>
getSlackChannels#
▸ getSlackChannels(teamId): Promise<any>
Parameters#
| Name | Type |
|---|---|
teamId | string |
Returns#
Promise<any>
getSlackTeams#
▸ getSlackTeams(): Promise<any>
Returns#
Promise<any>
getTeamsChannels#
▸ getTeamsChannels(tenantId): Promise<any>
Returns Channels available for a given user ID.
Parameters#
| Name | Type | Description |
|---|---|---|
tenantId | string | An ID returned after authenticating the user with MS Teams. |
Returns#
Promise<any>
loadAllItems#
▸ loadAllItems(assetId): Promise<SocialItemsResponse>
Parameters#
| Name | Type |
|---|---|
assetId | string |
Returns#
Promise<SocialItemsResponse>
loadBlacklist#
▸ loadBlacklist(accountId, socialNetwork): Promise<any>
Parameters#
| Name | Type |
|---|---|
accountId | string |
socialNetwork | string |
Returns#
Promise<any>
lookupTwitterId#
▸ lookupTwitterId(username): Promise<any>
Parameters#
| Name | Type |
|---|---|
username | string |
Returns#
Promise<any>
openPreapprovalDialog#
▸ openPreapprovalDialog(feed, iconUrl, options?): Promise<any>
Parameters#
| Name | Type |
|---|---|
feed | any |
iconUrl | string |
options? | PreapprovalDialogOptions |
Returns#
Promise<any>
refreshFeed#
▸ refreshFeed(feedId): Promise<any>
Gets new Facebook posts
Parameters#
| Name | Type |
|---|---|
feedId | string |
Returns#
Promise<any>
removeItem#
▸ removeItem(itemId, assetId): Promise<any>
Parameters#
| Name | Type |
|---|---|
itemId | string |
assetId | string |
Returns#
Promise<any>
saveFeed#
▸ saveFeed(feed): Promise<any>
Parameters#
| Name | Type |
|---|---|
feed | any |
Returns#
Promise<any>
twitterSubscriptionStatus#
▸ twitterSubscriptionStatus(): Promise<TwitterSubscriptionStatusResponse>
Returns#
Promise<TwitterSubscriptionStatusResponse>
unbanUser#
▸ unbanUser(username, socialNetwork, accountId): Promise<any>
Parameters#
| Name | Type |
|---|---|
username | string |
socialNetwork | string |
accountId | string |
Returns#
Promise<any>
unfavoriteItem#
▸ unfavoriteItem(itemId, assetId, network): Promise<any>
Parameters#
| Name | Type |
|---|---|
itemId | string |
assetId | string |
network | string |
Returns#
Promise<any>