SippoGroup

public class SippoGroup

Represents a group

Properties

  • Name of the group

    Declaration

    Swift

    public var name: String { get }
  • Group identifier

    Declaration

    Swift

    public var groupId: String { get }
  • Users who are joined to group

    Declaration

    Swift

    public var participants: [User]!

Api

  • Add a new participant to group

    Declaration

    Swift

    public func add(participant: String, result: @escaping (Result<Void, ResourceError>) -> Void)

    Parameters

    participant

    Participant to be added

    result

    Result with success when actions is completed

  • As group owners expel a participant from group

    Declaration

    Swift

    public func expel(participant: String, result: @escaping (Result<Void, ResourceError>) -> Void)

    Parameters

    participant

    Participant to be expelled

    result

    Result with success when actions is completed

  • Leave the group

    Declaration

    Swift

    public func leave(result: @escaping (Result<Void, ResourceError>) -> Void)

    Parameters

    result

    Result with success when actions is completed

  • As group owner expel all participants

    Declaration

    Swift

    public func removeAllUsers(result: @escaping (Result<Void, ResourceError>) -> Void)

    Parameters

    result

    Result with success when actions is completed

  • Check if a participant belongs to the group

    Declaration

    Swift

    public func hasParticipant(_ participant: String, result: @escaping (Result<Bool, ResourceError>) -> Void)

    Parameters

    participant

    Participant to check

    result

    Result with true if group contains the participant

  • Fetch phonebooks associated to the group

    Declaration

    Swift

    public func fetchPhonebooks(result: @escaping (Result<[Phonebook], ResourceError>) -> Void)

    Parameters

    result

    Result with phonebooks