MembershipClient Class Reference


                    
                    
                    onEvent

The callback to receive events about membership changes.

Since

2.3.0

Declaration

Swift

public var onEvent: ((MembershipEvent) -> Void)? { get set }


                    
                    
                    onEventWithPayload

The callback to receive events with the event payload about membership changes.

Since

2.3.0

Declaration

Swift

public var onEventWithPayload: ((MembershipEvent, WebexEventPayload) -> Void)? { get set }


                    
                    
                    list(max:queue:completionHandler:)

Lists all space memberships where the authenticated user belongs.

Since

1.2.0

Declaration

Swift

public func list(max: Int? = nil, queue: DispatchQueue? = nil, completionHandler: @escaping (Result<[Membership]>) -> Void)

Parameters

`max`	The maximum number of items in the response.
`queue`	If not nil, the queue on which the completion handler is dispatched. Otherwise, the handler is dispatched on the application’s main thread.
`completionHandler`	A closure to be executed once the request has finished.

Return Value

Void


                    
                    
                    list(spaceId:max:queue:completionHandler:)

Lists all memberships in the given space by space Id.

Since

1.2.0

Declaration

Swift

public func list(spaceId: String, max: Int? = nil, queue: DispatchQueue? = nil, completionHandler: @escaping (Result<[Membership]>) -> Void)

Parameters

`spaceId`	The identifier of the space where the membership belongs. (Derived parameter: Use `SpaceClient.list(...)` to get the list of spaces. Then use `Space.id` to retrieve the spaceId)
`max`	The maximum number of memberships in the response.
`queue`	If not nil, the queue on which the completion handler is dispatched. Otherwise, the handler is dispatched on the application’s main thread.
`completionHandler`	A closure to be executed once the request has finished.

Return Value

Void


                    
                    
                    list(spaceId:personId:queue:completionHandler:)

Lists any space memberships for the given space (by space id) and person (by person id).

Since

1.2.0

Declaration

Swift

public func list(spaceId: String, personId: String, queue: DispatchQueue? = nil, completionHandler: @escaping (Result<[Membership]>) -> Void)

Parameters

`spaceId`	The identifier of the space where the memberships belong. (Derived parameter: Use `SpaceClient.list(...)` to get the list of spaces. Then use `Space.id` to retrieve the spaceId)
`personId`	The identifier of the person who has the memberships. (Derived parameter: Use `MembershipClient.list(...)` to get the list of members. Then use `Membership.personId` to get the personId of the member)
`queue`	If not nil, the queue on which the completion handler is dispatched. Otherwise, the handler is dispatched on the application’s main thread.
`completionHandler`	A closure to be executed once the request has finished.

Return Value

Void


                    
                    
                    list(spaceId:personEmail:queue:completionHandler:)

Lists any space memberships for the given space (by space id) and person (by email address).

Since

1.2.0

Declaration

Swift

public func list(spaceId: String, personEmail: EmailAddress, queue: DispatchQueue? = nil, completionHandler: @escaping (Result<[Membership]>) -> Void)

Parameters

`spaceId`	The identifier of the space where the memberships belong. (Derived parameter: Use `SpaceClient.list(...)` to get the list of spaces. Then use `Space.id` to retrieve the spaceId)
`personEmail`	The email address of the person who has the memberships. (Derived parameter: Use `MembershipClient.list(...)` to get the list of members. Then use `Membership.personEmail` to get the email address of the member)
`queue`	If not nil, the queue on which the completion handler is dispatched. Otherwise, the handler is dispatched on the application’s main thread.
`completionHandler`	A closure to be executed once the request has finished.

Return Value

Void


                    
                    
                    get(membershipId:queue:completionHandler:)

Retrieves the details for a membership by membership id.

Since

1.2.0

Declaration

Swift

public func get(membershipId: String, queue: DispatchQueue? = nil, completionHandler: @escaping (Result<Membership>) -> Void)

Parameters

`membershipId`	The identifier of the membership. (Derived parameter: Use `MembershipClient.list(...)` to get the list of members. Then use `Membership.id` to retrieve the membershipId)
`queue`	If not nil, the queue on which the completion handler is dispatched. Otherwise, the handler is dispatched on the application’s main thread.
`completionHandler`	A closure to be executed once the request has finished.

Return Value

Void


                    
                    
                    create(spaceId:personId:isModerator:queue:completionHandler:)

Adds a person to a space by person id; optionally making the person a moderator.

Since

1.2.0

Declaration

Swift

public func create(spaceId: String, personId: String, isModerator: Bool = false, queue: DispatchQueue? = nil, completionHandler: @escaping (Result<Membership>) -> Void)

Parameters

`spaceId`	The identifier of the space where the person is to be added. (Derived parameter: Use `SpaceClient.list(...)` to get the list of spaces. Then use `Space.id` to retrieve the spaceId)
`personId`	The identifier of the person to be added. (Derived parameter: Use `MembershipClient.list(...)` to get the list of members. Then use `Membership.personId` to get the personId of the member)
`isModerator`	If true, make the person a moderator of the space. The default is false.
`queue`	If not nil, the queue on which the completion handler is dispatched. Otherwise, the handler is dispatched on the application’s main thread.
`completionHandler`	A closure to be executed once the request has finished.

Return Value

Void


                    
                    
                    create(spaceId:personEmail:isModerator:queue:completionHandler:)

Adds a person to a space by email address; optionally making the person a moderator.

Since

1.2.0

Declaration

Swift

public func create(spaceId: String, personEmail: EmailAddress, isModerator: Bool = false, queue: DispatchQueue? = nil, completionHandler: @escaping (Result<Membership>) -> Void)

Parameters

`spaceId`	The identifier of the space where the person is to be added. (Derived parameter: Use `SpaceClient.list(...)` to get the list of spaces. Then use `Space.id` to retrieve the spaceId)
`personEmail`	The email address of the person to be added. (Derived parameter: Use `MembershipClient.list(...)` to get the list of members. Then use `Membership.personEmail` to get the email address of the member)
`isModerator`	If true, make the person a moderator of the space. The default is false.
`queue`	If not nil, the queue on which the completion handler is dispatched. Otherwise, the handler is dispatched on the application’s main thread.
`completionHandler`	A closure to be executed once the request has finished.

Return Value

Void


                    
                    
                    update(membershipId:isModerator:queue:completionHandler:)

Updates the properties of a membership by membership id.

Since

1.2.0

Declaration

Swift

public func update(membershipId: String, isModerator: Bool, queue: DispatchQueue? = nil, completionHandler: @escaping (Result<Membership>) -> Void)

Parameters

`membershipId`	The identifier of the membership. (Derived parameter: Use `MembershipClient.list(...)` to get the list of members. Then use `Membership.id` to retrieve the membershipId)
`isModerator`	If true, make the person a moderator of the space in this membership. The default is false.
`queue`	If not nil, the queue on which the completion handler is dispatched. Otherwise, the handler is dispatched on the application’s main thread.
`completionHandler`	A closure to be executed once the request has finished.

Return Value

Void


                    
                    
                    delete(membershipId:queue:completionHandler:)

Deletes a membership by membership id. It removes the person from the space where the membership belongs.

Since

1.2.0

Declaration

Swift

public func delete(membershipId: String, queue: DispatchQueue? = nil, completionHandler: @escaping (Result<Void>) -> Void)

Parameters

`membershipId`	The identifier of the membership. (Derived parameter: Use `MembershipClient.list(...)` to get the list of members. Then use `Membership.id` to retrieve the membershipId)
`queue`	If not nil, the queue on which the completion handler is dispatched. Otherwise, the handler is dispatched on the application’s main thread.
`completionHandler`	A closure to be executed once the request has finished.

Return Value

Void


                    
                    
                    listWithReadStatus(spaceId:queue:completionHandler:)

Returns a list of memberships with details about the lastSeenId for each user so that application can tell which message was the last message was read by each user.

Since

2.3.0

Declaration

Swift

public func listWithReadStatus(spaceId: String, queue: DispatchQueue? = nil, completionHandler: @escaping (Result<[MembershipReadStatus]>) -> Void)

Parameters

`spaceId`	The identifier of the space. (Derived parameter: Use `SpaceClient.list(...)` to get the list of spaces. Then use `Space.id` to retrieve the spaceId)
`queue`	If not nil, the queue on which the completion handler is dispatched. Otherwise, the handler is dispatched on the application’s main thread.
`completionHandler`	A closure to be executed once the request has finished.

Return Value

Void