Enumerations

The following enumerations are available globally.

  • All Channel Type

    Declaration

    Objective-C

    enum EkoChannelType {}

    Swift

    enum EkoChannelType : UInt

  • Channel Type that allowed to be created

    Declaration

    Objective-C

    enum EkoChannelCreateType {}

    Swift

    enum EkoChannelCreateType : UInt

  • Reflection of the data state.

    Use this property to verify that the data is actually:

    • fresh (verified from the server)
    • from the local storage only

    • and more.

    • EkoDataStatusNotExist: The data does not exist locally.

    • EkoDataStatusLocal: The data is fetched from local database.

    • EkoDataStatusFresh: The data is fresh.

    • EkoDataStatusError: The data is invalid, this is set in conjunction with LoadingStatusError.

    Declaration

    Objective-C

    enum EkoDataStatus {}

    Swift

    enum EkoDataStatus : Int

  • Errors that can happen within the SDK.

    • EkoErrorCodeUnauthorized: The action is not allowed with the current logged-in user.
    • EkoErrorCodeUserIsMuted: The action cannot be completed because the user is muted in the channel.
    • EkoErrorCodeChannelIsMuted: The action cannot be completed because the entire channel is muted.
    • EkoErrorCodeUserIsBanned: The action cannot be completed because the user is banned.
    • MaxRepetitionExceed: The action cannot be completed because it has been done too frequently.
    • EkoErrorCodeBanWordFound: The action cannot be completed because a blacklist word has been detected.
    • EkoErrorCodeGlobalBanError: The logged-in user is banned globally from using the SDK.
    • EkoErrorCodeInvalidParameter: The action cannot be completed because a parameter is invalid.
    • EkoErrorCodeQueryInProgress: There’s a query already in progress.

    Declaration

    Objective-C

    enum EkoErrorCode {}

    Swift

    enum EkoErrorCode : Int

  • Channel Membership types.

    Each member can be only on one state at any given time.

    • EkoChannelMembershipNone: Not a member of this channel.
    • EkoChannelMembershipMember: Standard member.
    • EkoChannelMembershipBanned: Banned member.

    Declaration

    Objective-C

    enum EkoChannelMembershipType {}

    Swift

    enum EkoChannelMembershipType : UInt

  • Sort type option for sorting the user

    Declaration

    Objective-C

    enum EkoUserSortOption {}

    Swift

    enum EkoUserSortOption : UInt

  • Sort type option for sorting the user feed

    Declaration

    Objective-C

    enum EkoUserFeedSortOption {}

    Swift

    enum EkoUserFeedSortOption : UInt

  • Sync State

    Declaration

    Objective-C

    enum EkoSyncState {}

    Swift

    enum EkoSyncState : Int

  • Message Type

    • EkoMessageTypeText: A text message.
    • EkoMessageTypeImage: An image message.
    • EkoMessageTypeFile: A file message.
    • EkoMessageTypeCustom: A custom message.

    Declaration

    Objective-C

    enum EkoMessageType {}

    Swift

    enum EkoMessageType : Int

  • Media Size

    See more

    Declaration

    Objective-C

    enum EkoMediaSize {}

    Swift

    enum EkoMediaSize : Int

  • Reference Type

    • EkoReferenceTypeMessage: A text message.

    Declaration

    Objective-C

    enum EkoReferenceType {}

    Swift

    enum EkoReferenceType : Int