HouseholdAPI

public enum HouseholdAPI

Caseless enumeration with static methods to send Household Requests

  • Sends a request to create a new member as a household member.

    Declaration

    Swift

    public static func createMember(with parameters: Parameters,
                                completion: ResponseCompletion<Bool> = nil)

    Parameters

    parameters

    The Parameters to apply.
    completion

    The closure to be executed once the request has finished.

  • Sends a request to add existing member to household member.

    Declaration

    Swift

    public static func addMember(id: Int,
                             with parameters: Parameters? = nil,
                             completion: ResponseCompletion<Bool> = nil)

    Parameters

    id

    ID of the household member.
    parameters

    The Parameters to apply.
    completion

    The closure to be executed once the request has finished.

  • Sends a request to remove a member from the household.

    Declaration

    Swift

    public static func removeMember(id: Int,
                                with parameters: Parameters? = nil,
                                completion: ResponseCompletion<Bool> = nil)

    Parameters

    id

    ID of the household member.
    parameters

    The Parameters to apply.
    completion

    The closure to be executed once the request has finished.