getsocial-react-native-sdk

7.1.5

Action

Action class.

new Action(actionMap: any)
Parameters
actionMap (any) notification parameters
Static Members
create(type, data)

PurchaseData

Purchase data object.

new PurchaseData()
Instance Members
toJSON()

CommunitiesAction

CommunitiesAction object.

new CommunitiesAction()

CommunitiesEntityType

CommunitiesEntityType object.

new CommunitiesEntityType()

MemberStatus

MemberStatus object.

new MemberStatus()
Static Members
ApprovalPending
InvitationPending
Member

MembersQuery

MembersQuery object.

new MembersQuery(groupId: string)
Parameters
groupId (string)
Static Members
ofGroup(groupId)
Instance Members
withRole(role)
withStatus(status)

Mention

Mention object.

new Mention(mentionMap: any)
Parameters
mentionMap (any) reaction parameters

RemoveActivitiesQuery

RemoveActivitiesQuery object.

new RemoveActivitiesQuery(ids: Array<string>)
Parameters
ids (Array<string>)
Static Members
activityIds(ids)

ReportingReason

Reporting reason constants.

new ReportingReason()

Role

Role object.

new Role()

Topic

Topic object.

new Topic(topicMap: any)
Parameters
topicMap (any) activity parameters

User

Immutable properties for a user.

new User(userMap: any)
Parameters
userMap (any) public user parameters
Instance Members
userId
displayName
avatarUrl
identities
publicProperties
isVerified
updateDetails(update)
isAnonymous()
addIdentity(identity, onSuccess, onConflict, onError)
removeIdentity(providerId)
refresh()

User

GetSocialUser class.

new User(userMap: any)
Parameters
userMap (any) public user parameters
Instance Members
userId
displayName
avatarUrl
identities
publicProperties
isVerified
updateDetails(update)
isAnonymous()
addIdentity(identity, onSuccess, onConflict, onError)
removeIdentity(providerId)
refresh()

Invite

Invite object.

new Invite(inviteMap: any)
Parameters
inviteMap (any) invite channel parameters

InviteChannel

Describes as Invite channel and it's default invite content.

new InviteChannel(channelObject: any)
Parameters
channelObject (any) invite channel parameters
Instance Members
channelId
name
iconUrl
displayOrder

NotificationBadge

NotificationBadge object.

new NotificationBadge()
Static Members
increase(by)
set(to)
Instance Members
toJSON()

NotificationContext

NotificationContext object.

new NotificationContext(map: any)
Parameters
map (any)

NotificationStatus

Notification Status class.

new NotificationStatus()

ChatId

Chat object.

new ChatId(id: string?, userId: UserId?)
Parameters
id (string?)
userId (UserId?)
Static Members
create(id)
createWithUserId(userId)

ChatMessagesPagingQuery

ChatMessagesPagingQuery object.

new ChatMessagesPagingQuery(query: ChatMessagesQuery)
Parameters
Instance Members
toJSON()

ChatMessagesPagingResult

ChatMessagesPagingResult object.

new ChatMessagesPagingResult(resultMap: any)
Parameters
resultMap (any) result parameters

ChatMessagesQuery

ChatMessagesQuery object.

new ChatMessagesQuery(chatId: ChatId)
Parameters
chatId (ChatId)
Static Members
messagesInChat(id)

CommunitiesSettings

CommunitiesSettings object.

new CommunitiesSettings(settingsMap: any)
Parameters
settingsMap (any)
Instance Members
isActionAllowed(action)

Group

Group object.

new Group(groupMap: any)
Parameters
groupMap (any) activity parameters

Identity

Authentication Identity class.

new Identity()
Static Members
createFacebookIdentity(accessToken)
createCustomIdentity(customProviderName, userId, accessToken)
Instance Members
toJSON()

ReactionsQuery

ReactionsQuery object.

new ReactionsQuery(ids: CommunitiesIds)
Parameters
ids (CommunitiesIds)
Static Members
forActivity(id)
Instance Members
withReaction(reaction)

UserReactions

UserReactions object.

new UserReactions(reactionsMap: any)
Parameters
reactionsMap (any) reaction parameters

ReferralData

Class describes Referral Data.

new ReferralData(referralDataMap: any)
Parameters
referralDataMap (any) referral data parameters
Instance Members
token
referrerUserId
referrerChannelId
isFirstMatch
isGuaranteedMatch
isReinstall
referralLinkParams
originalReferralLinksParams

ReferralUsersQuery

ReferralUsersQuery object.

new ReferralUsersQuery(event: string?)
Parameters
event (string?)
Static Members
allUsers()
usersForEvent(event)
Instance Members
toJSON()

NotificationButton

NotificationButton object.

new NotificationButton(buttonMap: any)
Parameters
buttonMap (any) notification parameters
Static Members
create(title, actionId)

NotificationCustomization

NotificationCustomization object.

new NotificationCustomization(customizationMap: any)
Parameters
customizationMap (any) customization parameters
Instance Members
toJSON()

NotificationsQuery

Notifications Query class.

new NotificationsQuery()
Static Members
withStatus(status)
withAllStatus()
Instance Members
withActions(newActions)
ofTypes(newTypes)
toJSON()

PromoCode

PromoCode object.

new PromoCode(codeMap: any)
Parameters
codeMap (any)

PromoCodeContent

PromoCodeContent object.

new PromoCodeContent()
Static Members
withRandomCode()
withCode(code)
Instance Members
setTimeLimit(startDate, endDate)
toJSON()

ActivityButton

ActivityButton object.

new ActivityButton(activityButtonMap: any)
Parameters
activityButtonMap (any) activity button parameters
Static Members
create(title, action)

AnnouncementsQuery

AnnouncementsQuery object.

new AnnouncementsQuery(ids: CommunitiesIds)
Parameters
ids (CommunitiesIds)
Static Members
forFeedOf(id)
inTopic(id)
inGroup(id)
timeline()
Instance Members
toJSON()

Chat

Chat object.

new Chat(chatMap: any)
Parameters
chatMap (any) chat parameters

ChatMessage

ChatMessage object.

new ChatMessage(messageMap: any)
Parameters
messageMap (any) message parameters

CommunitiesEntity

CommunitiesEntity object.

new CommunitiesEntity(entityMap: any)
Parameters
entityMap (any) entity parameters
Instance Members
isActionAllowed(action)

FollowQuery

FollowQuery object.

new FollowQuery(ids: CommunitiesIds)
Parameters
ids (CommunitiesIds)
Static Members
topics(ids)
users(ids)
groups(ids)
Instance Members
toJSON()

FollowersQuery

FollowersQuery object.

new FollowersQuery(ids: CommunitiesIds)
Parameters
ids (CommunitiesIds)
Static Members
ofTopic(id)
ofGroup(id)
ofUser(id)
Instance Members
toJSON()

FriendsQuery

FriendsQuery object.

new FriendsQuery()
Static Members
ofUser(userId)
Instance Members
toJSON()

GroupsQuery

GroupsQuery object.

new GroupsQuery()
Static Members
all()
find(searchTerm)
Instance Members
followedBy(userId)
withMember(userId)
toJSON()

Membership

Membership object.

new Membership(membershipMap: any)
Parameters
membershipMap (any)

RemoveGroupMembersQuery

MembersQuery object.

new RemoveGroupMembersQuery(userIdList: UserIdList, groupId: string)
Parameters
userIdList (UserIdList)
groupId (string)
Static Members
create(groupId, userIdList)

SuggestedFriend

Immutable properties for a suggested friend.

new SuggestedFriend(suggestedFriendMap: any)

Extends User

Parameters
suggestedFriendMap (any) suggested friend parameters
Instance Members
mutualFriendsCount

TagsQuery

TagsQuery object.

new TagsQuery(search: string)
Parameters
search (string)
Static Members
search(searchTerm)
Instance Members
inTarget(target)
toJSON()

TopicsQuery

TopicsQuery object.

new TopicsQuery()
Static Members
all()
find(searchTerm)
Instance Members
followedBy(userId)
toJSON()

UsersQuery

UsersQuery object.

new UsersQuery(searchTerm: string, userId: UserId)
Parameters
searchTerm (string)
userId (UserId)
Static Members
find(searchTerm)
followedBy(id)
Instance Members
toJSON()

Analytics

Analytics interface of GetSocial plugin.

new Analytics()
Static Members
trackPurchase(purchaseData)
trackCustomEvent(eventName, eventProperties)

ActivitiesQuery

ActivitiesQuery object.

new ActivitiesQuery(ids: CommunitiesIds)
Parameters
ids (CommunitiesIds)
Static Members
feedOf(id)
inTopic(id)
inAllTopics()
inGroup(id)
timeline()
everywhere()
commentsToActivity(id)
Instance Members
byUser(id)
withTag(tag)
toJSON()

ChatMessageContent

ChatMessageContent object.

new ChatMessageContent()

GroupMember

GroupMember object.

new GroupMember(memberMap: any)

Extends User

Parameters
memberMap (any) suggested friend parameters

InviteContent

Class to specify custom invite content.

new InviteContent()
Instance Members
toJSON()

ReferralUser

Defines ReferredUser class.

new ReferralUser(referralUserMap: any)

Extends User

Parameters
referralUserMap (any) public user parameters

SendNotificationTarget

SendNotificationTarget object.

new SendNotificationTarget()
Static Members
create()
usersWithIds(userIdList)
Instance Members
addReceiverPlaceholder(placeholder)
toJSON()

ActivityContent

ActivityContent object.

new ActivityContent()

AddGroupMembersQuery

AddGroupMembersQuery object.

new AddGroupMembersQuery(query: UpdateGroupMembersQuery)
Parameters
Static Members
create(groupId, userIdList)
Instance Members
withRole(role)
withMemberStatus(memberStatus)
toJSON()

ConflictUser

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.

new ConflictUser(conflictUserMap: any)

Extends User

Parameters
conflictUserMap (any) conflict user parameters

GroupContent

GroupContent object.

new GroupContent()
Instance Members
toJSON()

PostActivityTarget

PostActivityTarget object.

new PostActivityTarget(ids: CommunitiesIds)
Parameters
ids (CommunitiesIds)
Static Members
topic(id)
group(id)
comment(activityId)
timeline()

UpdateGroupMembersQuery

UpdateGroupMembersQuery object.

new UpdateGroupMembersQuery(groupId: string, userIdList: UserIdList)
Parameters
groupId (string)
userIdList (UserIdList)
Static Members
create(groupId, userIdList)
Instance Members
withRole(role)
withMemberStatus(memberStatus)

PromoCodes

Analytics interface of GetSocial plugin.

new PromoCodes()
Static Members
create(content)
get(code)
claim(code)

JoinGroupQuery

JoinGroupQuery object.

new JoinGroupQuery(query: UpdateGroupMembersQuery)
Parameters
Static Members
create(groupId)
Instance Members
withInvitationToken(token)
toJSON()

GetSocial

Main interface of GetSocial plugin.

new GetSocial()
Static Members
init()
initWithAppId(appid)
addOnInitializedListener(onInit)
isInitialized()
getLanguage()
setLanguage(language)
isTestDevice()
getDeviceIdentifier()
getSdkVersion()
getCurrentUser()
addOnCurrentUserChangedListener(listener)
handleAction(action)
resetUser()
switchUser(identity)

Activity

Activity object.

new Activity(activityMap: any)
Parameters
activityMap (any) activity parameters

InvitesView

Invites view.

new InvitesView()
Instance Members
show()

Notification

Notification class.

new Notification(notificationMap: any)
Parameters
notificationMap (any) notification parameters

NotificationContent

NotificationContent class.

new NotificationContent()
Static Members
withText(text)
withTemplate(templateName)
Instance Members
toJSON()

GetSocialUI

GetSocial UI class.

new GetSocialUI()
Static Members
closeView(saveViewState)
restoreView()
loadDefaultConfiguration()
loadConfiguration(path)

ActivitiesView

ActivitiesView object.

new ActivitiesView()
Static Members
create(query)
Instance Members
show()

NotificationCenterView

Notification center view.

new NotificationCenterView()
Static Members
create(query)
Instance Members
show()

Notifications

Notification interface of GetSocial plugin.

new Notifications()
Static Members
registerDevice()
setOnNotificationReceivedListener(listener)
setOnNotificationClickedListener(listener)
setOnTokenReceivedListener(listener)
arePushNotificationsEnabled()
setPushNotificationsEnabled(enabled)
get(query)
getCount(query)
send(content, target)
setStatus(status, notificationIds)

Invites

Invites interface of GetSocial plugin.

new Invites()
Static Members
getAvailableChannels()
createURL(linkParams)
send(inviteContent, channelId, onComplete, onCancel, onError)
create(inviteContent)
setOnReferralDataReceivedListener(onReferralDataReceived)
getReferredUsers(query)
getReferrerUsers(query)
setReferrer(userId, event, eventData)

Communities

Analytics interface of GetSocial plugin.

new Communities()
Static Members
addFriends(ids)
removeFriends(ids)
areFriends(ids)
isFriend(id)
getFriendsCount(query)
getFriends(query)
getSuggestedFriends(query)
setFriends(ids)
getUsers(query)
getUsersByIds(ids)
getUser(id)
getUsersCount(query)
follow(query)
unfollow(query)
isFollowing(id, query)
getFollowers(query)
getFollowersCount(query)
getAnnouncements(query)
getActivities(query)
getActivity(id)
postActivity(content, target)
updateActivity(id, content)
addReaction(reaction, activityId)
removeReaction(reaction, activityId)
getReactions(query)
reportActivity(id, reason, explanation)
removeActivities(query)
getTags(query)
getTopic(id)
getTopics(query)
getTopicsCount(query)
createGroup(groupContent)
updateGroup(groupId, groupContent)
removeGroups(groupIds)
getGroup(groupId)
getGroups(query)
getGroupsCount(query)
addGroupMembers(query)
joinGroup(query)
updateGroupMembers(query)
removeGroupMembers(query)
getGroupMembers(query)
areGroupMembers(groupId, userIds)
sendChatMessage(content, target)
getChatMessages(query)
getChats(query)
getChat(chatId)