7.12.6Label object.
(any)
label parameters
Tag object.
(any)
tag parameters
Action class.
(any)
notification parameters
Purchase data object.
CommunitiesAction object.
CommunitiesEntityType object.
MemberStatus object.
Mention object.
(any)
reaction parameters
PollStatus object.
RemoveActivitiesQuery object.
Remove activities with IDs.
([string])
array of activities IDs.
RemoveActivitiesQuery:
new instance.
Reporting reason constants.
Role object.
Topic object.
(any)
activity parameters
Immutable properties for a user.
(any)
public user parameters
Returns all identities added to the user.
Type: {}
All public properties of user.
Type: {}
Requests a bulk change of properties for the current user.
(UserUpdate)
New user details.
void:
A callback to indicate if this operation was successful.
Returns if current user has any authentication info attached.
bool:
true, if user does not have any authentication info attached.
Adds Identity for the specified provider.
(Identity)
AuthIdentity to be added.
(function ())
called when identity successfully added.
(function (conflictUser: ConflictUser))
called when identity conflicts with another user.
(function (error))
called when an error occured during adding identity.
void:
Method simply returns after invoking, check the callbacks for result.
GetSocialUser class.
(any)
public user parameters
Returns all identities added to the user.
Type: {}
All public properties of user.
Type: {}
Requests a bulk change of properties for the current user.
(UserUpdate)
New user details.
void:
A callback to indicate if this operation was successful.
Returns if current user has any authentication info attached.
bool:
true, if user does not have any authentication info attached.
Adds Identity for the specified provider.
(Identity)
AuthIdentity to be added.
(function ())
called when identity successfully added.
(function (conflictUser: ConflictUser))
called when identity conflicts with another user.
(function (error))
called when an error occured during adding identity.
void:
Method simply returns after invoking, check the callbacks for result.
Invite object.
(any)
invite channel parameters
Describes as Invite channel and it's default invite content.
(any)
invite channel parameters
NotificationBadge object.
Creates badge to increase badge number.
(number)
Increase by.
NotificationBadge:
New instance.
Creates badge to set badge number.
(number)
Badge value.
NotificationBadge:
New instance.
NotificationContext object.
(any)
Notification Status class.
Chat object.
(string?)
(UserId?)
ChatMessagesPagingQuery object.
(ChatMessagesQuery)
ChatMessagesPagingResult object.
(any)
result parameters
ChatMessagesQuery object.
(ChatId)
Get messages in a chat.
(ChatId)
Id of chat.
ChatMessagesQuery:
new query.
CommunitiesSettings object.
(any)
Group object.
(any)
activity parameters
Authentication Identity class.
Create custom identity.
(string)
Your custom provider name.
(string)
Unique user identifier for your custom provider.
(string)
Password of the user for your custom provider.
It's a string, provided by the developer and it will be
required by the GetSocial SDK to validate any future
intent to add this same identity to another user.
Identity:
Instance for your custom provider.
MembersQuery object.
(string)
Create a query to get members of a group.
(string)
ID of activity.
MembersQuery:
new query object.
Filters members by role.
(number)
Member role.
MembersQuery:
the same query instance.
Filters members by status.
(number)
Member status.
MembersQuery:
the same query instance.
Filter members by username or displayName.
(string)
Beginning of name.
MembersQuery:
same query.
ReactionsQuery object.
(CommunitiesIds)
Get all users reacted to activity with ID.
(string)
ID of activity.
ReactionsQuery:
new query object.
Get only users reacted with specific reaction.
(string)
name of the reaction to filter by.
ReactionsQuery:
the same query instance.
UserReactions object.
(any)
reaction parameters
UserVotes object.
(any)
reaction parameters
VotesQuery object.
(CommunitiesIds)
Get all users voted to activity with ID.
(string)
ID of activity.
VotesQuery:
new query object.
Get only users reacted with specific poll option.
(string)
id of the poll option to filter by.
VotesQuery:
the same query instance.
Class describes Referral Data.
(any)
referral data parameters
Unique Smart Invite link token. There is unique association between token and attached referral data.
Type: string
The GetSocial user id of the user that created the referral data.
Type: string?
The id of the channel that was used for the invite.
Type: string?
Returns true if the app is installed for the first time on this device.
Type: boolean
returns true if GetSocial can give 100% guarantee that received referral data corresponds to the user, false in case of the best match.
Type: boolean
Returns true if the app is opened for this link the first time on this device.
Type: boolean
Referral Link parameters that are assigned to this referral data. Includes value overrides from the Smart Link.
Type: {}
Original Referral Link parameters that are assigned to this referral data. Contains original link parameters attached to the Smart Link without overrides.
Type: {}
ReferralUsersQuery object.
(string?)
Creates new query to filter all the users.
ReferralUsersQuery:
new ReferralUsersQuery instance.
Creates new query to filter users for the specified event.
(string)
name of event.
ReferralUsersQuery:
new ReferralUsersQuery instance.
NotificationButton object.
(any)
notification parameters
Create a new notification button.
(string)
title of the button.
NotificationButton:
new instance.
NotificationCustomization object.
(any)
customization parameters
Notifications Query class.
Creates a new notifications query with the provided statuses.
([string])
statuses to filter for.
NotificationsQuery:
new query instance.
Creates a new notifications count query with all the available statuses.
NotificationsCountQuery:
new query instance.
Sets actions to filter for.
([string])
actions to filter for.
NotificationsQuery:
updated query instance.
Sets types to filter for.
([string])
types to filter for.
NotificationsQuery:
updated query instance.
PromoCode object.
(any)
PromoCodeContent object.
Create a Promo Code with a random code.
PromoCodeContent:
new promo code content instance.
Create a Promo Code with defined code.
(string)
code to be used as promo code.
PromoCodeContent:
new promo code content instance.
Set the time range when this Promo Code is available. If not set - will be available from the creation moment and until manually disabled on the Dashboard.
ActivityButton object.
(any)
activity button parameters
Create a new ActivityButton instance.
ActivityButton:
New instance.
Chat object.
(any)
chat parameters
ChatMessage object.
(any)
message parameters
CommunitiesEntity object.
(any)
entity parameters
FollowQuery object.
(CommunitiesIds)
Follow topics from list.
([string])
list of topic IDs.
FollowQuery:
new query.
Follow users from list.
(UserIdList)
list of user IDs.
FollowQuery:
new query.
Follow groups from list.
([string])
list of group IDs.
FollowQuery:
new query.
Follow tags from list.
([string])
list of tag IDs.
FollowQuery:
new query.
Follow labels from list.
([string])
list of label IDs.
FollowQuery:
new query.
FollowersQuery object.
(CommunitiesIds)
Get followers of topic with ID.
(string)
Topic ID.
FollowersQuery:
new query.
Get followers of group with ID.
(string)
Group ID.
FollowersQuery:
new query.
Get followers of user with ID.
(UserId)
User ID.
FollowersQuery:
new query.
Get followers of label with ID.
(string)
Label ID.
FollowersQuery:
new query.
Get followers of tag with ID.
(string)
Label ID.
FollowersQuery:
new query.
Filter followers by username or displayName.
(string)
Beginning of name.
FollowersQuery:
same query.
FriendsQuery object.
Get friends of a user.
(UserId)
user ID.
FriendsQuery:
new query.
GroupsQuery object.
Get all groups.
GroupsQuery:
new instance.
Find groups by name or description.
(string)
groups name/description or part of it.
GroupsQuery:
new instance.
Get groups followed by a specific user.
(UserId)
ID of user.
GroupsQuery:
same instance.
Get groups by member.
(UserId)
ID of user.
GroupsQuery:
same instance.
Get only trending groups.
(boolean)
Only trending groups or all.
GroupsQuery:
same query.
Get groups matching the specified properties.
GroupsQuery:
same query.
Get groups matching the specified labels.
([string])
Labels list.
GroupsQuery:
same query.
LabelsQuery object.
(string)
All labels.
LabelsQuery:
New instance.
Search for a specific label.
(string)
Search term.
LabelsQuery:
New instance.
Get only trending labels.
(boolean)
Only trending labels or all.
LabelsQuery:
same query.
Get labels followed by a specific user.
(UserId)
User ID.
LabelsQuery:
same query.
Membership object.
(any)
PollOption object.
(any)
option parameters
MembersQuery object.
(UserIdList)
(string)
Create a query to remove members of a group.
(string)
ID of group.
(UserIdList)
User ids to remove.
MembersQuery:
new query object.
SearchQuery object.
(string)
Get all entities.
SearchQuery:
A new query.
Find entities.
(string)
String to search.
SearchQuery:
A new query.
Get only trending entities.
([CommunitiesEntityType])
List of entities to search.
SearchQuery:
Same query.
Get entities with the specified properties.
SearchQuery:
same query.
Get entities with the specified labels.
([string])
Labels list.
SearchQuery:
same query.
Immutable properties for a suggested friend.
Extends User
(any)
suggested friend parameters
TopicsQuery object.
Get all topics.
TopicsQuery:
new instance.
Find topics by name or description.
(string)
topics name/description or part of it.
TopicsQuery:
new instance.
Get topics followed by a specific user.
(UserId)
ID of user.
TopicsQuery:
same instance.
Get only trending topics.
(boolean)
Only trending topics or all.
TopicsQuery:
same query.
Get topics matching the specified properties.
TopicsQuery:
same query.
Get topics matching the specified labels.
([string])
Labels list.
TopicsQuery:
same query.
UsersQuery object.
(string)
(UserId)
Create a query to find users, that have query string in their Display Name.
(string)
part of display name.
UsersQuery:
new instance.
Get users followed by a specific user.
(UserId)
ID of user.
UsersQuery:
new instance.
Get suggested users.
UsersQuery:
new instance.
Analytics interface of GetSocial plugin.
Reports in-app purchase to Dashboard.
(PurchaseData)
Purchase data.
boolean:
True if operation was successful, otherwise false.
AnnouncementsQuery object.
(CommunitiesIds)
Get announcements for user's feed.
(UserId)
id of the user.
AnnouncementsQuery:
a new query.
Get announcements in topic.
(string)
id of topic.
AnnouncementsQuery:
a new query.
Get announcements in a group.
(string)
ID of group.
AnnouncementsQuery:
new query.
Get announcements for all feeds and targeting users timeline.
AnnouncementsQuery:
a new query.
Get activities with the specified poll status.
(number)
Poll status value.
AnnouncementsQuery:
new query.
ChatMessageContent object.
GroupMember object.
Extends User
(any)
suggested friend parameters
Poll object.
(any)
poll parameters
PollContent object.
PollOptionContent object.
TagsQuery object.
(string)
Filter in which target execute the search.
(PostActivityTarget)
Search target.
TagsQuery:
same instance.
Class to specify custom invite content.
Defines ReferredUser class.
Extends User
(any)
public user parameters
SendNotificationTarget object.
Create a new notification target.
SendNotificationTarget:
new instance.
Create a new notification target with list of users.
(UserIdList)
list of user to receive notification.
SendNotificationTarget:
new instance.
Add a placeholder.
SendNotificationTarget:
same instance for methods chaining.
ActivitiesQuery object.
(CommunitiesIds)
Get activities in user feed.
(UserId)
ID of user.
ActivitiesQuery:
new query.
Get activities in a topic.
(string)
ID of topic.
ActivitiesQuery:
new query.
Get activities from all topics.
ActivitiesQuery:
new query.
Get activities in a group.
(string)
ID of group.
ActivitiesQuery:
new query.
Get activities in user's timeline.
ActivitiesQuery:
new query.
Get all activities.
ActivitiesQuery:
new query.
Get comments to a certain activity.
(string)
ID of activity.
ActivitiesQuery:
new query.
Get bookmarked activities.
ActivitiesQuery:
new query.
Get activities that match given reaction(s).
([string])
ActivitiesQuery:
new query.
Get polls voted with the given option(s).
([string])
ActivitiesQuery:
new query.
Get activities of a specific user.
(UserId)
author of activities.
ActivitiesQuery:
same query.
Get activities with a specific tag.
(string)
tag in activity text.
ActivitiesQuery:
same query.
Get activities with the specified poll status.
(number)
Poll status value.
ActivitiesQuery:
same query.
Get only trending activities.
(boolean)
Only trending activities or all.
ActivitiesQuery:
same query.
Get activities matching the specified text.
(string)
Text.
ActivitiesQuery:
same query.
Get activities matching the specified properties.
ActivitiesQuery:
same query.
Get activities matching the specified labels.
([string])
Labels list.
ActivitiesQuery:
same query.
Get activities matching the specified mentions.
([UserId])
User IDs.
ActivitiesQuery:
same query.
Include a number of comments from each activity in the response.
(number)
Number of comments to include (max: 3)
ActivitiesQuery:
same query.
AddGroupMembersQuery object.
(UpdateGroupMembersQuery)
Create query to add users to a group.
(string)
Id of group to add members to.
(UserIdList)
Users to add to group.
AddGroupMembersQuery:
new instance.
Define role for users.
(Role)
Default role of users.
UpdateGroupMembersQuery:
Updated query.
Define status for users.
(MemberStatus)
Default status of users.
UpdateGroupMembersQuery:
Updated query.
When trying to add an identity and conflict in identities happens a ConflictUser instance is returned to check the details of the conflict user to see which user you want to proceed with.
Extends User
(any)
conflict user parameters
GroupContent object.
PostActivityTarget object.
(CommunitiesIds)
Post activity in topic.
(string)
ID of topic to be posted in.
PostActivityTarget:
new instance.
Post activity in group.
(string)
ID of group to be posted in.
PostActivityTarget:
new instance.
Post comment to the activity.
(string)
ID of activity to be commented.
PostActivityTarget:
new instance.
Post to the feed of current user.
PostActivityTarget:
new instance.
UpdateGroupMembersQuery object.
(string)
(UserIdList)
Create query to add users to a group.
(string)
Id of group to add members to.
(UserIdList)
List of user to add to group.
UpdateGroupMembersQuery:
new instance.
Define role for users.
(Role)
Default role of users.
UpdateGroupMembersQuery:
Updated query.
Define status for users.
(MemberStatus)
Default status of users.
UpdateGroupMembersQuery:
Updated query.
Analytics interface of GetSocial plugin.
Create a promo code.
(PromoCodeContent)
promo code data.
PromoCode:
Callback with created promo code or error.
ActivityContent object.
JoinGroupQuery object.
(UpdateGroupMembersQuery)
Create query to add users to a group.
(string)
Id of group to add members to.
JoinGroupQuery:
new instance.
Add invitation token.
(string)
Invitation token.
JoinGroupQuery:
Updated query instance.
Main interface of GetSocial plugin.
Initializes the SDK, App Id will be taken from .plist or .gradle files. Use whenInitialized method to get notified when initialization finished.
Current user.
CurrentUser:
current user or null if SDK is not initialized.
Add listener to be notified when the user was changed. The listener action is executed on the main thread, so be careful with operations, that you put inside. Listener will be invoked when:
(function)
Listener to be notified.
Reset current user and create a new anonymous one.
void:
Called if successfully reset user.
Reset current user and without creating a new user. SDK will be uninitialized.
void:
Called if successfully reset.
Invites view.
Shows the invites view.
void:
void.
Activity object.
(any)
activity parameters
Notification class.
(any)
notification parameters
NotificationContent class.
Creates a new NotificationContent instance.
(string)
notification text.
NotificationContent:
new NotificationContent instance.
Creates a new NotificationContent instance from the template configured on the GetSocial Dashboard.
(string)
name of the template on the GetSocial Dashboard. Case-sensitive.
NotificationContent:
new NotificationContent instance.
GetSocial UI class.
SearchResult object.
(Object)
Notification center view.
Creates NotificationCenterView to show notifications based on {query} parameter.
(NotificationsQuery)
Defines which notifications will be shown.
NotificationCenterView:
View instance.
Shows the notification center view.
void:
void.
Notification interface of GetSocial plugin.
Call this method to register for push notifications.
Set a notification listener, you can handle a click on notification in NotificationContext) method.
(function)
An object that will be notified with clicked notification.
Returns notifications based on the provided query.
(NotificationsPagingQuery)
to use to filter notifications.
Promise<[Notification]>:
List of notifications based on the query.
Sends the provided notification content to the recipients.
(NotificationContent)
Content of push notification.
(SendNotificationTarget)
List of recipients.
Promise<NotificationsSummary>:
Summary of sending notifications.
ActivitiesView object.
Creates ActivitiesView to show activities based on {query} parameter.
(ActivitiesQuery)
Defines which activities will be shown.
ActivitiesView:
View instance.
Shows the view.
Invites interface of GetSocial plugin.
Get the list of available invite channels. Contains only channels enabled on the Dashboard and available on the device.
[InviteChannel]:
called with a list of available invite channels.
Invite friends via a specified invite channel.
(InviteContent)
Custom content to override the default content provided from the Dashboard.
(string)
The channel through which the invite will be sent, one of the constants defined in
InviteChannelIds
.
(function ())
called when an invite was sent.
(function ())
called when an invite sending was canceled.
(function (string))
called when an error occured during sending an invite.
void:
Method simply returns after invoking, check the callbacks for result.
Invite friends via a specified invite channel.
(InviteContent)
Custom content to override the default content provided from the Dashboard.
void:
Method simply returns after invoking, check the callbacks for result.
Returns list of users who were referred by this user for a specific event.
(PagingQuery<ReferralUsersQuery>)
Users query.
PagingResult<ReferralUser>:
Called with list of referred users. If there is no referred user, the list is empty.
Returns list of users who are referrers for this user for a specific event.
(PagingQuery<ReferralUsersQuery>)
Users query.
PagingResult<ReferralUser>:
Called with list of referred users. If there is no referred user, the list is empty.
Analytics interface of GetSocial plugin.
Add users to a friend list, if operation succeed - user become friends with everyone in the list. If some or all users are already in the friends list, they will be ignored.
(UserIdList)
you want to become friend with.
number:
Callback with updated number of friends.
Get number of friends.
(FriendsQuery)
Query.
number:
Called with count of friends.
Get a list of friends for current user.
(PagingQuery<FriendsQuery>)
Pagination query.
PagingResult<User>:
Called with list of users that are friends of current user.
Get a list of suggested friends for current user.
(PagingQuery)
Pagination query.
PagingResult<SuggestedFriend>:
Called with list of users that are friends of current user.
Get users matching query. Returns a list of users and a cursor for a next query. If cursor is empty string, or PagingResult#isLastPage() is true, this is a last page.
(PagingQuery<UsersQuery>)
Users query and pagination details.
PagingResult<User>:
Called with a list of results and a cursor for a next query.
Get total count of users matching provided query.
(UsersQuery)
Users query.
number:
Called with a number of users matching the query.
Follow users or topics. If follow users, returns a number of users you are following now. If follow topics, returns a number of topics you are following now.
(FollowQuery)
Topics or users to be followed.
number:
Called with a total number of users/topics you follow after the call.
Unfollow users or topics. If unfollow users, returns a number of users you are following now. If unfollow topics, returns a number of topics you are following now.
(FollowQuery)
Topics or users to be followed.
number:
Called with a total number of users/topics you follow after the call.
Check if user with given ID is following a list of entities. Returns a map, where key is an id of entity. Value indicated if user follows the entity for that key.
(UserId)
ID of user to check if he follows certain entities.
(FollowQuery)
List of entities to check.
Map<string, boolean>:
Called with a map of results.
Get users who follow certain entity. Returns a list of followers and a cursor for a next query. If cursor is empty string, or PagingResult#isLastPage() is true, this is a last page.
(PagingQuery<FollowersQuery>)
Followers query and pagination details.
PagingResult<User>:
Called with list of followers and a cursor for a next query.
Get total count of users who follows certain entity.
(FollowersQuery)
Followers query.
number:
Called with a number of users who follows certain entity.
Get announcements matching query. Returns a list of announcements.
(AnnouncementsQuery)
Announcements query and pagination details.
[Activity]:
Called with list of announcements.
Get activities matching query. Returns a list of activities and a cursor for a next query. If cursor is empty string, or PagingResult#isLastPage() is true, this is a last page.
(PagingQuery<ActivitiesQuery>)
Activities query and pagination details.
PagingResult<Activity>:
Called with list of activities and a cursor for a next query.
Post activity to a specific target.
(ActivityContent)
Content of activity which should be posted.
(PostActivityTarget)
A target where activity should be posted.
Activity:
Called with activity object if it was posted successfully.
Update activity with a new content. Activity is entire replaced.
(string)
Id of activity to be updated.
(ActivityContent)
Content of activity which should be posted.
Activity:
Called with activity object if it was posted successfully.
Set reaction to the activity. If this reaction was already added, success is called. Existing reactions will be removed.
void:
Called if operation was successful.
Add reaction to the activity. If this reaction was already added, success is called. Existing reactions will be kept.
void:
Called if operation was successful.
Get reactions matching query. Returns a list of reactions and a cursor for a next query. If cursor is empty string, or PagingResult#isLastPage() is true, this is a last page.
(PagingQuery<ReactionsQuery>)
Reactions query and pagination details.
PagingResult<UserReactions>:
Called with list of reactions and a cursor for a next query.
Get votes matching query. Returns a list of votes and a cursor for a next query. If cursor is empty string, or PagingResult#isLastPage() is true, this is a last page.
(PagingQuery<VotesQuery>)
Votes query and pagination details.
PagingResult<UserVotes>:
Called with list of votes and a cursor for a next query.
Remove all activities matching query.
(RemoveActivitiesQuery)
Which activities should be removed.
void:
Called if operation succeeded.
Get labels matching query. Returns a list of labels.
(PagingQuery<LabelsQuery>)
Labels query and pagination details.
PagingResult<[Label]>:
Called with list of labels and a cursor for a next query.
Get labels count for matching query. Returns amount of labels.
(LabelsQuery)
Labels query.
number:
Called with labels count.
Get topics matching query. Returns a list of topics and a cursor for a next query. If cursor is empty string, or PagingResult#isLastPage() is true, this is a last page.
(PagingQuery<TopicsQuery>)
Tags query and pagination details.
PagingResult<Topic>:
Called with list of topics and a cursor for a next query.
Get total count of topics matching provided query.
(TopicsQuery)
Topics query.
number:
Called with a number of topics matching the query.
Create a new group.
(GroupContent)
Group content.
Group:
Called with created group.
Update an existing group.
(string)
Group id to update.
(GroupContent)
New group content.
Group:
Called with updated group.
Get groups based on query parameters.
(PagingQuery<GroupsQuery>)
Query parameter.
PagingResult<Group>:
Called with groups.
Get number of groups based on query parameters.
(GroupsQuery)
Query parameter.
number:
Called with number of groups.
Add group members to a group.
(AddGroupMembersQuery)
Query parameter.
[GroupMember]:
Called with new group members.
Current user join to group.
(JoinGroupQuery)
Query parameter.
GroupMember:
Called with new group member.
Update an existing group member.
(UpdateGroupMembersQuery)
Query parameter.
[GroupMember]:
Called with updated member.
Remove users from a group.
(RemoveGroupMembersQuery)
Query parameter.
void:
Called if operation succeeded.
Get members of a group.
(PagingQuery<MembersQuery>)
Query parameter.
PagingResult<GroupMember>:
Called with group members.
Check if users are member of group.
(string)
Group id.
(UserIdList)
User ids to check.
Map<string, Membership>:
Result map.
Send chat message to the specified recipient.
(ChatMessageContent)
Chat message content.
(ChatId)
Chat message target.
ChatMessage:
Called with the sent message.
Get chat messages.
(ChatMessagesPagingQuery)
Query parameter.
PagingResult<ChatMessage>:
Called with chat messages.
Search topics, groups, users, activities, tags and labels by matching query. Returns a list of each of those entities with a cursor for a next query. If cursor is empty string, or PagingResult#isLastPage() is true, this is a last page.
(PagingQuery<SearchQuery>)
Search query and pagination.
SearchResult:
Promise with Result and cursor(s) for next query.
Block one or more users.
(UserIdList)
List of User IDs to block.
void:
Called if operation succeeded.
Unblock one or more users.
(UserIdList)
List of User IDs to unblock.
void:
Called if operation succeeded.