Communities

@objcMembers
@objc(GetSocialCommunities)
public class Communities : NSObject

Interface for community related methods.

Friends


                    
                    
                    addFriends(_:success:failure:)

Add a friend to current user, if operation succeeds, they both became friends. If try to add a user who is already a friend, success callback will be called, but user will be added to friends list only once and friends count won’t be increased.

Declaration

Swift

@objc(addFriendsWithIds:success:failure:)
public static func addFriends(_ ids: UserIdList, success: @escaping ResultCallback<Int>, failure: @escaping FailureCallback)

Parameters

`ids`	List of user identifiers to add as friend.
`success`	Called if friend ware added.
`failure`	Callend called if operation failed.

removeFriends(_:success:failure:)
Remove users from friends list. If trying to remove a user who is not a friend, success callback will be called, and user’s friends count won’t be decreased.
Declaration
Swift

@objc(removeFriendsWithIds:success:failure:) public static func removeFriends(_ ids: UserIdList, success: @escaping ResultCallback<Int>, failure: @escaping FailureCallback)


                    
                    
                    areFriends(_:success:failure:)

Check if users are friend of current user.

Declaration

Swift

@objc(areFriendsWithIds:success:failure:)
public static func areFriends(_ ids: UserIdList, success: @escaping ResultCallback<[String : Bool]>, failure: @escaping FailureCallback)


                    
                    
                    isFriend(_:success:failure:)

Check if user is friend of current user.

Declaration

Swift

@objc(isFriendWithId:success:failure:)
public static func isFriend(_ id: UserId, success: @escaping ResultCallback<Bool>, failure: @escaping FailureCallback)


                    
                    
                    friendsCount(_:success:failure:)

Return number of friends of a user.

Declaration

Swift

@objc(friendsCountWithQuery:success:failure:)
public static func friendsCount(_ query: FriendsQuery, success: @escaping ResultCallback<Int>, failure: @escaping FailureCallback)


                    
                    
                    friends(_:success:failure:)

Get a list of friends of a user.

Declaration

Swift

@objc(friendsWithQuery:success:failure:)
public static func friends(_ query: FriendsPagingQuery, success: @escaping ResultCallback<FriendsPagingResult>, failure: @escaping FailureCallback)


                    
                    
                    suggestedFriends(_:success:failure:)

Get a list of suggested friends of current user.

Declaration

Swift

@objc(suggestedFriendsWithQuery:success:failure:)
public static func suggestedFriends(_ query: SuggestedFriendsPagingQuery, success: @escaping ResultCallback<SuggestedFriendsPagingResult>, failure: @escaping FailureCallback)


                    
                    
                    setFriends(_:success:failure:)

Set the provided users as friends of current user.

Important

Existing friends will be removed!

Declaration

Swift

@objc(setFriendsWithIds:success:failure:)
public static func setFriends(_ ids: UserIdList, success: @escaping ResultCallback<Int>, failure: @escaping FailureCallback)

Users


                    
                    
                    users(_:success:failure:)

Find users.

Declaration

Swift

@objc(usersWithQuery:success:failure:)
public static func users(_ query: UsersPagingQuery, success: @escaping ResultCallback<UsersPagingResult>, failure: @escaping FailureCallback)


                    
                    
                    users(_:success:failure:)

Get multiple users by identifiers.

Declaration

Swift

@objc(usersWithIds:success:failure:)
public static func users(_ ids: UserIdList, success: @escaping ResultCallback<[String : User]>, failure: @escaping FailureCallback)


                    
                    
                    user(_:success:failure:)

Get single user by identifier.

Declaration

Swift

@objc(userWithId:success:failure:)
public static func user(_ id: UserId, success: @escaping ResultCallback<User>, failure: @escaping FailureCallback)


                    
                    
                    usersCount(_:success:failure:)

Return number of user matching the provided query.

Declaration

Swift

@objc(usersCountWithQuery:success:failure:)
public static func usersCount(_ query: UsersQuery, success: @escaping ResultCallback<Int>, failure: @escaping FailureCallback)

Follow/Unfollow


                    
                    
                    follow(_:success:failure:)

Follow a community entity, like topic or user.

Declaration

Swift

@objc(followWithQuery:success:failure:)
public static func follow(_ query: FollowQuery, success: @escaping ResultCallback<Int>, failure: @escaping FailureCallback)


                    
                    
                    unfollow(_:success:failure:)

Unfollow a community entity, like topic or user.

Declaration

Swift

@objc(unfollowWithQuery:success:failure:)
public static func unfollow(_ query: FollowQuery, success: @escaping ResultCallback<Int>, failure: @escaping FailureCallback)


                    
                    
                    isFollowing(_:query:success:failure:)

Check if a user follows a community entity, like topic or user.

Declaration

Swift

@objc(isFollowingWithUserId:query:success:failure:)
public static func isFollowing(_ id: UserId, query: FollowQuery, success: @escaping ResultCallback<[String : Bool]>, failure: @escaping FailureCallback)


                    
                    
                    followers(_:success:failure:)

Get followers of a community entity, like topic or user.

Declaration

Swift

@objc(followersWithQuery:success:failure:)
public static func followers(_ query: FollowersPagingQuery, success: @escaping ResultCallback<UsersPagingResult>, failure: @escaping FailureCallback)


                    
                    
                    followersCount(_:success:failure:)

Get number of followers of a community entity, like topic or user.

Declaration

Swift

@objc(followersCountWithQuery:success:failure:)
public static func followersCount(_ query: FollowersQuery, success: @escaping ResultCallback<Int>, failure: @escaping FailureCallback)

Feeds


                    
                    
                    announcements(_:success:failure:)

Get announcements.

Declaration

Swift

@objc(announcementsWithQuery:success:failure:)
public static func announcements(_ query: AnnouncementsQuery, success: @escaping ResultCallback<[Activity]>, failure: @escaping FailureCallback)


                    
                    
                    activities(_:success:failure:)

Get activities.

Declaration

Swift

@objc(activitiesWithQuery:success:failure:)
public static func activities(_ query: ActivitiesPagingQuery, success: @escaping ResultCallback<ActivitiesPagingResult>, failure: @escaping FailureCallback)


                    
                    
                    activity(_:success:failure:)

Get a single activity.

Declaration

Swift

@objc(activityWithId:success:failure:)
public static func activity(_ id: String, success: @escaping ResultCallback<Activity>, failure: @escaping FailureCallback)


                    
                    
                    postActivity(_:target:success:failure:)

Post activity content to the specified target.

Declaration

Swift

@objc(postActivityContent:target:success:failure:)
public static func postActivity(_ content: ActivityContent, target: PostActivityTarget, success: @escaping ResultCallback<Activity>, failure: @escaping FailureCallback)


                    
                    
                    updateActivity(_:content:success:failure:)

Update existing activity with provided content.

Declaration

Swift

@objc(updateActivityWithId:content:success:failure:)
public static func updateActivity(_ id: String, content: ActivityContent, success: @escaping ResultCallback<Activity>, failure: @escaping FailureCallback)


                    
                    
                    addReaction(_:activityId:success:failure:)

Add a new reaction to an activity, existing reactions will be kept.

Declaration

Swift

@objc(addReaction:toActivityWithId:success:failure:)
public static func addReaction(_ reaction: String, activityId: String, success: @escaping SuccessCallback, failure: @escaping FailureCallback)

setReaction(_:activityId:success:failure:)
Set a reaction to an activity, existing reaction will be removed.
- reaction: Reaction to add.
- activityId: To add the reaction to.
- success: Called if operation succeeded.
- failure: Called if operation failed.
Declaration
Swift

@objc(setReaction:toActivityWithId:success:failure:) public static func setReaction(_ reaction: String, activityId: String, success: @escaping SuccessCallback, failure: @escaping FailureCallback)


                    
                    
                    removeReaction(_:activityId:success:failure:)

Remove a reaction from an activity.

Declaration

Swift

@objc(removeReaction:fromActivityWithId:success:failure:)
public static func removeReaction(_ reaction: String, activityId: String, success: @escaping SuccessCallback, failure: @escaping FailureCallback)


                    
                    
                    reactions(_:success:failure:)

Get reactions.

Declaration

Swift

@objc(reactionsWithQuery:success:failure:)
public static func reactions(_ query: ReactionsPagingQuery, success: @escaping ResultCallback<ReactionsPagingResult>, failure: @escaping FailureCallback)


                    
                    
                    bookmark(_:success:failure:)

Bookmark activity.

Declaration

Swift

@objc(bookmark:success:failure:)
public static func bookmark(_ activityId: String, success: @escaping SuccessCallback, failure: @escaping FailureCallback)

Parameters

`activityId`	To add the bookmark to.
`success`	Called if operation succeeded.
`failure`	Called if operation failed.


                    
                    
                    removeBookmark(_:success:failure:)

Remove Bookmark from an activity.

Declaration

Swift

@objc(removeBookmark:success:failure:)
public static func removeBookmark(_ activityId: String, success: @escaping SuccessCallback, failure: @escaping FailureCallback)

Parameters

`activityId`	To remove the bookmark from.
`success`	Called if operation succeeded.
`failure`	Called if operation failed.


                    
                    
                    reportActivity(_:reason:explanation:success:failure:)

Report an activity.

Declaration

Swift

@objc(reportActivityWithId:reason:explanation:success:failure:)
public static func reportActivity(_ id: String, reason: ReportingReason, explanation: String?, success: @escaping SuccessCallback, failure: @escaping FailureCallback)


                    
                    
                    removeActivities(_:success:failure:)

Remove activities.

Declaration

Swift

@objc(removeActivitiesWithQuery:success:failure:)
public static func removeActivities(_ query: RemoveActivitiesQuery, success: @escaping SuccessCallback, failure: @escaping FailureCallback)


                    
                    
                    tags(_:success:failure:)

Get tags matching query.

Declaration

Swift

@objc(tagsWithQuery:success:failure:)
public static func tags(_ query: TagsPagingQuery, success: @escaping ResultCallback<TagsPagingResult>, failure: @escaping FailureCallback)


                    
                    
                    tagsCount(_:success:failure:)

Get number of tags.

Declaration

Swift

@objc(tagsCountWithQuery:success:failure:)
public static func tagsCount(_ query: TagsQuery, success: @escaping ResultCallback<Int>, failure: @escaping FailureCallback)

Parameters

`query`	Query parameter.
`success`	Called with number of tags.
`failure`	Called if operation failed.


                    
                    
                    labels(_:success:failure:)

Get labels matching query

Declaration

Swift

@objc(labelsWithQuery:success:failure:)
public static func labels(_ query: LabelsPagingQuery, success: @escaping ResultCallback<LabelsPagingResult>, failure: @escaping FailureCallback)

Parameters

`query`	Query parameters.
`success`	Called with list of labels.
`failure`	Called if operation failed.


                    
                    
                    labelsCount(_:success:failure:)

Get number of labels.

Declaration

Swift

@objc(labelsCountWithQuery:success:failure:)
public static func labelsCount(_ query: LabelsQuery, success: @escaping ResultCallback<Int>, failure: @escaping FailureCallback)

Parameters

`query`	Query parameter.
`success`	Called with number of labels.
`failure`	Called if operation failed.

Topics


                    
                    
                    topic(_:success:failure:)

Get a single topic.

Declaration

Swift

@objc(topicWithId:success:failure:)
public static func topic(_ id: String, success: @escaping ResultCallback<Topic>, failure: @escaping FailureCallback)


                    
                    
                    topics(_:success:failure:)

Find topics.

Declaration

Swift

@objc(topicsWithQuery:success:failure:)
public static func topics(_ query: TopicsPagingQuery, success: @escaping ResultCallback<TopicsPagingResult>, failure: @escaping FailureCallback)


                    
                    
                    topicsCount(_:success:failure:)

Get number of topics.

Declaration

Swift

@objc(topicsCountWithQuery:success:failure:)
public static func topicsCount(_ query: TopicsQuery, success: @escaping ResultCallback<Int>, failure: @escaping FailureCallback)

Groups


                    
                    
                    createGroup(_:success:failure:)

Creates a new group.

Declaration

Swift

@objc(createGroupWithContent:success:failure:)
public static func createGroup(_ content: GroupContent, success: @escaping ResultCallback<Group>, failure: @escaping FailureCallback)


                    
                    
                    updateGroup(_:content:success:failure:)

Updates an existing group.

Declaration

Swift

@objc(updateGroupWithId:content:success:failure:)
public static func updateGroup(_ id: String, content: GroupContent, success: @escaping ResultCallback<Group>, failure: @escaping FailureCallback)


                    
                    
                    removeGroups(_:success:failure:)

Removes groups.

Declaration

Swift

@objc(removeGroupsWithIds:success:failure:)
public static func removeGroups(_ ids: [String], success: @escaping SuccessCallback, failure: @escaping FailureCallback)


                    
                    
                    membersOfGroup(_:success:failure:)

Get members of the provided group.

Declaration

Swift

@objc(membersOfGroupWithQuery:success:failure:)
public static func membersOfGroup(_ query: MembersPagingQuery, success: @escaping ResultCallback<GroupMembersPagingResult>, failure: @escaping FailureCallback)


                    
                    
                    groups(_:success:failure:)

Get groups.

Declaration

Swift

@objc(groupsWithQuery:success:failure:)
public static func groups(_ query: GroupsPagingQuery, success: @escaping ResultCallback<GroupsPagingResult>, failure: @escaping FailureCallback)


                    
                    
                    groupsCount(_:success:failure:)

Get number of groups.

Declaration

Swift

@objc(groupsCountWithQuery:success:failure:)
public static func groupsCount(_ query: GroupsQuery, success: @escaping ResultCallback<Int>, failure: @escaping FailureCallback)


                    
                    
                    group(_:success:failure:)

Get group by id.

Declaration

Swift

@objc(groupWithId:success:failure:)
public static func group(_ id: String, success: @escaping ResultCallback<Group>, failure: @escaping FailureCallback)


                    
                    
                    addGroupMembers(_:success:failure:)

Adds user to a group.

Declaration

Swift

@objc(addGroupMembersWithQuery:success:failure:)
public static func addGroupMembers(_ query: AddGroupMembersQuery, success: @escaping ResultCallback<[GroupMember]>, failure: @escaping FailureCallback)


                    
                    
                    joinGroup(_:success:failure:)

Current user joins a group.

Declaration

Swift

@objc(joinGroupWithQuery:success:failure:)
public static func joinGroup(_ query: JoinGroupQuery, success: @escaping ResultCallback<GroupMember>, failure: @escaping FailureCallback)


                    
                    
                    updateGroupMembers(_:success:failure:)

Updates an existing group member.

Declaration

Swift

@objc(updateGroupMembersWithQuery:success:failure:)
public static func updateGroupMembers(_ query: UpdateGroupMembersQuery, success: @escaping ResultCallback<[GroupMember]>, failure: @escaping FailureCallback)


                    
                    
                    removeGroupMembers(_:success:failure:)

Removes member from group.

Declaration

Swift

@objc(removeGroupMembersWithQuery:success:failure:)
public static func removeGroupMembers(_ query: RemoveGroupMembersQuery, success: @escaping SuccessCallback, failure: @escaping FailureCallback)


                    
                    
                    areGroupMembers(of:userIds:success:failure:)

Checks if users are member of group.

Declaration

Swift

@objc(areGroupMembersOf:userIds:success:failure:)
public static func areGroupMembers(of id: String, userIds: UserIdList, success: @escaping ResultCallback<[String : Membership]>, failure: @escaping FailureCallback)

Chat


                    
                    
                    sendChatMessage(_:target:success:failure:)

Sends a chat message to the provided target.

Declaration

Swift

public static func sendChatMessage(_ content: ChatMessageContent, target: ChatId, success: @escaping ResultCallback<ChatMessage>, failure: @escaping FailureCallback)


                    
                    
                    chatMessages(_:success:failure:)

Retrieves existing chat messages.

Declaration

Swift

public static func chatMessages(_ query: ChatMessagesPagingQuery, success: @escaping ResultCallback<ChatMessagesPagingResult>, failure: @escaping FailureCallback)

chats(_:success:failure:)
Retrieves existing chats.
- query: Chats paging query.
- success: Called with list of chats.
- failure: Called if operation failed.
Declaration
Swift

public static func chats(_ query: ChatsPagingQuery, success: @escaping ResultCallback<ChatsPagingResult>, failure: @escaping FailureCallback)


                    
                    
                    chat(_:success:failure:)

Retrieves existing chat by id.

Declaration

Swift

public static func chat(_ id: ChatId, success: @escaping ResultCallback<Chat>, failure: @escaping FailureCallback)

Polls

addVotes(_:activityId:success:failure:)
Add new votes to an activity, existing votes will be kept.
- pollOptionIds: Votes to add.
- activityId: To add the votes to.
- success: Called if operation succeeded.
- failure: Called if operation failed.
Declaration
Swift

@objc(addVotes:toActivityWithId:success:failure:) public static func addVotes(_ pollOptionIds: Set<String>, activityId: String, success: @escaping SuccessCallback, failure: @escaping FailureCallback)
setVotes(_:activityId:success:failure:)
Set votes to an activity, existing votes will be removed.
- pollOptionIds: Votes to add.
- activityId: To add the votes to.
- success: Called if operation succeeded.
- failure: Called if operation failed.
Declaration
Swift

@objc(setVotes:toActivityWithId:success:failure:) public static func setVotes(_ pollOptionIds: Set<String>, activityId: String, success: @escaping SuccessCallback, failure: @escaping FailureCallback)
removeVotes(_:activityId:success:failure:)
Remove votes from an activity.
- pollOptionIds: Votes to remove.
- activityId: To remove the votes from.
- success: Called if operation succeeded.
- failure: Called if operation failed.
Declaration
Swift

@objc(removeVotes:fromActivityWithId:success:failure:) public static func removeVotes(_ pollOptionIds: Set<String>, activityId: String, success: @escaping SuccessCallback, failure: @escaping FailureCallback)


                    
                    
                    votes(_:success:failure:)

Get votes.

query: Query parameters.
success: Called with reactions.
failure: Called if operation failed.

Declaration

Swift

@objc(votesWithQuery:success:failure:)
public static func votes(_ query: VotesPagingQuery, success: @escaping ResultCallback<VotesPagingResult>, failure: @escaping FailureCallback)


                    
                    
                    search(_:success:failure:)

Search.

Declaration

Swift

@objc(searchWithQuery:success:failure:)
public static func search(_ query: SearchPagingQuery, success: @escaping ResultCallback<SearchResult>, failure: @escaping FailureCallback)

Parameters

`query`	Query parameter.
`success`	Called with results.
`failure`	Called if operation failed.