0.3.2ActionButton class.
(any)
action button parameters
Creates a new ActionButton instance with the provided parameters.
ActionButton:
new ActionButton instance.
Describes as Invite channel and it's default invite content.
(any)
invite channel parameters
Media attachment class.
Creates media attachment instance with image url.
(string)
Url of the image.
MediaAttachment:
Created media attachment instance.
Creates media attachment instance with video url.
(string)
Url of the video.
MediaAttachment:
Created media attachment instance.
(string)
Uri of the image.
Creates media attachment instance with local image uri.
MediaAttachment:
Created media attachment instance.
Creates media attachment instance with local video uri.
(string)
Uri of the video.
MediaAttachment:
Created media attachment instance.
Notification Status class.
Notifications Count Query class.
Creates a new notifications count query with the provided statuses.
([string])
statuses to filter for.
NotificationsCountQuery:
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.
NotificationsCountQuery:
updated query instance.
Sets types to filter for.
([string])
types to filter for.
NotificationsCountQuery:
updated query instance.
Notifications Query class.
Creates a new notifications count 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 maximum number of returned notifications.
(number)
maximum number of notifications to return.
NotificationsQuery:
updated query instance.
Load older or newer notifications.
NotificationsQuery:
query for method chaining.
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.
Notification Summary class.
(any)
map with parameters.
Immutable properties for a public user.
(any)
public user parameters
Lightweight representation of a public user.
(any)
user reference parameters
Authentication Identity class.
Creates a Facebook identity with specified access token.
(string)
Token of Facebook user returned from FB SDK.
AuthIdentity:
New instance for Facebook user with specified access token.
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.
AuthIdentity:
Instance for your custom provider.
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: {}
UsersQuery class.
Creates a query to find users, that have query string in their display name.
(string)
Part of display name.
UsersQuery:
New instance.
Creates a query to find users, that have query string in their display name.
(number)
New limit, should be between 1 and 20.
UsersQuery:
New instance.
Immutable properties for a suggested friend.
Extends PublicUser
(any)
suggested friend parameters
Class to specify custom invite content.
Set custom invite text.
(string)
invite text.
CustomInviteContent:
modified instance.
Set custom invite text.
(string)
invite subject.
CustomInviteContent:
modified instance.
Set media attachment.
(string)
media attachment.
CustomInviteContent:
modified instance.
Defines ReferredUser class.
Extends PublicUser
(any)
public user parameters
Action class.
(any)
notification parameters
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 PublicUser
(any)
conflict user parameters
GetSocial UI class.
Displays GetSocial view, which was hidden using closeView.
Creates invites view.
InvitesView:
Returns the created invites view.
Creates notification center view.
NotificationCenterView:
Returns the created invites view.
Notification class.
(any)
notification parameters
Invites view.
Set custom window title.
(string)
title.
InvitesView:
modified instance.
Set custom invite content.
(CustomInviteContent)
Custom invite content.
InvitesView:
modified instance.
Set callbacks for different invites events.
(function (string))
called when an invite was sent.
(function (string))
called when an invite sending was canceled.
InvitesView:
modified instance.
Set link params.
(Map)
Link parameters.
InvitesView:
modified instance.
Shows the invites view.
void:
void.
Notification center view.
Set custom window title.
(string)
title.
NotificationCenterView:
modified instance.
Sets filter for notification types.
([string])
filter for types.
NotificationCenterView:
modified instance
Sets filter for notification actions.
([string])
filter for actions.
NotificationCenterView:
modified instance
Sets a listener to be invoked if a notification is clicked on the UI.
(void)
listener to be invoked.
NotificationCenterView:
updated instance.
Sets a listener to be invoked if an action button in a notification is clicked on the UI.
(void)
listener to be invoked.
NotificationCenterView:
updated instance.
Shows the notification center view.
void:
void.
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.
Sets a notification action.
(Action)
notification action to perform.
NotificationContent:
updated NotificationContent instance.
Set notification title. If you use template, your title will be overriden by this.
(string)
notification title.
NotificationContent:
updated NotificationContent instance.
Sets a notification action. Set notification text. If you use template, your text will be overriden by this.
(string)
notification text.
NotificationContent:
updated NotificationContent instance.
Set template name. Notification will use values from the GetSocial Dashboard as title and text. But #withTitle(string) or #withText(string) have higher priority and will override template values.
(string)
name of the template on the dashboard. Case-sensitive.
NotificationContent:
updated NotificationContent instance.
If you specified placeholders on the GetSocial Dashboard for your template title or text - you can replace it using this method. For example, if your template text it "Hello, [USERNAME].", call notificationContent.addTemplatePlaceholder("USERNAME", "My actual name"). Brackets should be omitted in key. Won't make any effect without template name.
(string)
placeholder on the GetSocial Dashboard.
(string)
actual text that should be used instead.
NotificationContent:
updated NotificationContent instance.
Add all keys and values from map to template placeholders.
NotificationContent:
updated NotificationContent instance.
Attach media(image, video) to notification.
(MediaAttachment)
media attachment.
NotificationContent:
updated NotificationContent instance.
Attach action button to notifications.
(ActionButton)
action button to show.
NotificationContent:
updated NotificationContent instance.
Attach action buttons to notifications.
([ActionButton])
action button to show.
NotificationContent:
updated NotificationContent instance.
Event emitter to subscribe GetSocial related events. Available events: 1. whenInitialized: invoked when SDK finished initialization. 2. onUserChanged: invoked when any property of current user changed. 3. onGlobalError(error): invoked when an unhandled error happened. 4. onNotificationReceived(notification, wasClicked): invoked when a notification is clicked, or when a notification received while the app is in foreground.
GetSocialUser class.
Returns if current user has any authentication info attached.
bool:
true, if user does not have any authentication info attached.
Adds AuthIdentity for the specified provider.
(AuthIdentity)
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.
Switches the current user to the user identified by details provided.
(AuthIdentity)
to be switched to.
Promise<void>:
Called when operation finished.
Add a friend for current user, if operation succeed - they both became friends. If you're trying to add a user, that already is your friend, Callback#onSuccess(Object) will be called, but user will be added to your friends list only once and your friends count won't be increased.
(string)
Unique user identifier you want to become friend with.
Promise<number>:
Called when operation finished, returns current number of friends.
Add a list of users to the list of current user friends. This method can be used to import external social graph data to GetSocial.
(string)
A auth identity provider id for which user ids will be provided. Can be "facebook", or any custom value.
(string)
A list of user ids on the selected identity provider that need to be added to the current user's friends list.
Promise<number>:
Called when operation finished, returns current number of friends.
Remove a user from friends list. If you're trying to remove a user, that is not your friend, your friends count won't be decreased.
(string)
Unique user identifier you don't want to be friends anymore.
Promise<number>:
Called when operation finished, returns current number of friends.
Remove a list of users for list of current user's friends.
(string)
A auth identity provider id for which user ids will be provided. Can be "facebook", or any custom value.
(string)
A list of user ids on the selected identity provider that need to be removed from the current user's friends list.
Promise<number>:
Called when operation finished, returns current number of friends.
Replace existing friends with the provided list of users.
(string)
An auth identity provider id for which user ids will be provided. Can be "facebook", or any custom value.
([string])
A list of user ids on the selected identity provider that will be set as the current user's friends list.
Promise<void>:
Called when operation finished.
Get a list of friends for current user.
Promise<[PublicUser]>:
Called when operation finished with list of friends.
Get a list of suggested friends for current user.
Promise<[SuggestedFriend]>:
Called when operation finished with list of suggested friends.
Returns notifications based on the provided query.
(NotificationsQuery)
to use to filter notifications.
Promise<[Notification]>:
List of notifications based on the query.
Returns number of notifications based on the provided query.
(NotificationsCountQuery)
to use to filter notifications.
Promise<number>:
Number of notifications based on the query.
Sends the provided notification content to the recipients.
(NotificationContent)
Content of push notification.
Promise<NotificationsSummary>:
Summary of sending notifications.
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.
Invite friends via a specified invite channel.
(string)
The channel through which the invite will be sent, one of the constants defined in
InviteChannelIds
.
(CustomInviteContent)
Custom content to override the default content provided from the Dashboard.
(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.
Returns all supported invite channels.
Promise<[InviteChannel]>:
List containing all available channels.
Returns referral data.
Promise<ReferralData>:
: ReferralData instance.
Returns list of users who installed the app by accepting invite of current user.
Promise<[ReferredUser]>:
: List of referred users, can be empty.
Fetch a user by their GetSocial userId.
(string)
The GetSocial userId.
Promise<PublicUser>:
Promise returning a PublicUser instance or error.
Fetch a user by auth provider id and user id on this provider.
(string)
Auth identity provider id for which user id is provided. Can be "facebook", or any custom value.
(string)
User id on the selected identity provider for which PublicUser will be returned.
Promise<PublicUser>:
Promise returning a PublicUser instance or error.
Fetch a list of users by their auth identities pairs. Auth identity pair is a combination of provider id and user id on this provider.
(string)
A auth identity provider id for which user ids will be provided. Can be "facebook", or any custom value.
([string])
A list of user ids on the selected identity provider for which
PublicUser
s will be returned.
Promise<Map<string, PublicUser>>:
Promise returning a map of provider user id with matching PublicUser instance or error Please note, that not all requested user may be returned.
Find users matching query.
(UsersQuery)
users query.
Promise<[UserReference]>:
Promise returning a list of users.
Call this method to register for push notifications.