Functions

The following functions are available globally.

  • An utility function that translates BCHChatClientState values in a human readable string.

    Declaration

    Objective-C

    extern NSString *_Nonnull NSStringFromBCHChatClientState(
    BCHChatClientState state)

    Swift

    func NSStringFromBCHChatClientState(_ state: BCHChatClientState) -> String

    Parameters

    state

    The client state.

    Return Value

    A human readable string representing the value passed as argument.

  • An utility function that returns a human readable string from BCXCallDirection enumeration value.

    Declaration

    Objective-C

    extern NSString *_Nonnull NSStringFromBCXCallDirection(
    BCXCallDirection direction)

    Swift

    func NSStringFromBCXCallDirection(_ direction: BCXCallDirection) -> String

    Parameters

    direction

    The direction value.

    Return Value

    A human readable string representing the value passed as argument.

  • An utility function that returns a human readable string from BCXCallState enumeration value.

    Declaration

    Objective-C

    extern NSString *_Nonnull NSStringFromBCXCallState(BCXCallState state)

    Swift

    func NSStringFromBCXCallState(_ state: BCXCallState) -> String

    Parameters

    state

    The state value.

    Return Value

    A human readable string representing the value passed as argument.

  • An utility function that returns a human readable string from BCXCallEndReason enumeration value.

    Declaration

    Objective-C

    extern NSString *_Nonnull NSStringFromBCXCallEndReason(
    BCXCallEndReason endReason)

    Swift

    func NSStringFromBCXCallEndReason(_ endReason: BCXCallEndReason) -> String

    Parameters

    endReason

    The end reason value.

    Return Value

    A human readable string representing the value passed as argument.

  • An utility function that returns a human readable string from BCXDeclineReason enumeration value.

    Declaration

    Objective-C

    extern NSString *_Nonnull NSStringFromBCXDeclineReason(BCXDeclineReason reason)

    Swift

    func NSStringFromBCXDeclineReason(_ reason: BCXDeclineReason) -> String

    Parameters

    reason

    the decline reason value.

    Return Value

    A human readable string representing the value passed as argument.

  • An utility function that returns a human readable string from BCXCallType enumeration value.

    Declaration

    Objective-C

    extern NSString *_Nonnull NSStringFromBCXCallType(BCXCallType type)

    Swift

    func NSStringFromBCXCallType(_ type: BCXCallType) -> String

    Parameters

    type

    the type value.

    Return Value

    A human readable string representing the value passed as argument.

  • An utility function that returns a human readable string from call participant state enumeration value

    Declaration

    Objective-C

    extern NSString *_Nonnull NSStringFromBCXCallParticipantState(
    BCXCallParticipantState state)

    Swift

    func NSStringFromBCXCallParticipantState(_ state: BCXCallParticipantState) -> String

    Parameters

    state

    the participant state value

    Return Value

    A human readable string representing the value passed as argument

  • An utility function that returns a human readable string from user state enumeration value

    Declaration

    Objective-C

    extern NSString *_Nonnull NSStringFromBCXUserStatus(BCXUserStatus status)

    Swift

    func NSStringFromBCXUserStatus(_ status: BCXUserStatus) -> String

    Parameters

    status

    The user state enumeration value

    Return Value

    A human readable string representing the value passed as argument

  • An utility function that translates BCXCallClientState values in a human readable string.

    Declaration

    Objective-C

    extern NSString *_Nonnull NSStringFromBCXCallClientState(
    BCXCallClientState state)

    Swift

    func NSStringFromBCXCallClientState(_ state: BCXCallClientState) -> String

    Parameters

    state

    The client state.

    Return Value

    A human readable string representing the value passed as argument.