Global

Members

(readonly) EkoChannelType :string

Properties:
Name Type Description
Standard string Standard channels are optimized for large real-time group chats with thousands of people.
Private string
Conversation string
Broadcast string
Channel type.
Type:
  • string

(readonly) EkoCommentReferenceType :string

Properties:
Name Type Description
Post string
Content string
Reference type.
Type:
  • string

(readonly) EkoCommentDataType :string

Properties:
Name Type Description
Text string
Data type.
Type:
  • string

(readonly) EkoFeedType :string

Properties:
Name Type Description
ChannelFeed string
UserFeed string
MyFeed string
GlobalFeed string
Feed types.
Type:
  • string

(readonly) EkoFeedSortingMethod :string

Properties:
Name Type Description
FirstCreated string
LastCreated string
Feed sorting type.
Type:
  • string

(readonly) EkoFileType :string

Properties:
Name Type Description
Image string
File string
File types.
Type:
  • string

(readonly) EkoImageSize :string

Properties:
Name Type Description
Small string
Medium string
Large string
Full string
Image sizes.
Type:
  • string

(readonly) EkoChannelMembership :string

Properties:
Name Type Description
None string Not a member of the channel
Member string Member of the channel
Banned string Member banned from the channel
User membership type for the channel.
Type:
  • string

(readonly) EkoMemberFilter :string

Properties:
Name Type Description
All string All members
Muted string Only muted members.
Banned string Only banned members.
Membership filter for member list queries.
Type:
  • string

(readonly) EkoMessageType :string

Properties:
Name Type Description
Text string
Image string
File string
Custom string
Message type.
Type:
  • string

(readonly) EkoSyncState :string

Properties:
Name Type Description
Default string Initial message state
Synced string Message sent to the server.
Syncing string Message in progress of sending to the server.
Error string Message can not be send to the server. Please check error.
Message sync state. Specifies if the message has been successfully sent to the server.
Type:
  • string

(readonly) EkoPostTargetType :string

Post target types.
Type:
  • string

(readonly) EkoPostDataType :string

Properties:
Name Type Description
TextPost string
Post types.
Type:
  • string

(readonly) EkoPostSortingMethod :string

Properties:
Name Type Description
FirstCreated string
LastCreated string
Post sorting type.
Type:
  • string

(readonly) EkoReactionEventType :string

Properties:
Name Type Description
Add string When a reaction is added
Remove string When a reaction is removed
Event type descriptor as received from server side event
Type:
  • string

(readonly) EkoUserSortingMethod :string

Properties:
Name Type Description
DisplayName string
FirstCreated string
LastCreated string
User sorting type.
Type:
  • string

(readonly) EkoConnectionStatus :string

Properties:
Name Type Description
NotConnected string The client has never been connected.
Disconnected string The client was once connected, but not anymore.
Connecting string The client is in the process of connecting.
Connected string The client is currently connected.
Connection statuses.
Type:
  • string

(readonly) EkoLoadingStatus :string

Properties:
Name Type Description
NotLoading string The data locally is already fresh, no need to load.
Loading string The client is currently loading this data from the server.
Loaded string The client has loaded the fresh data from the server and is up to date.
Error string The client has encoutered an error loading the data. Please check if IDs and parameters are correct.
Loading statuses.
Type:
  • string

(readonly) EkoDataStatus :string

Properties:
Name Type Description
NotExist string The data does not exist locally.
Local string The data is fetched from the local database.
Fresh string The data is fresh.
Error string The data is invalid. This is set in conjunction with EkoLoadingStatus.Error.
Data statuses
Type:
  • string

(readonly) EkoMediaSize :string

Properties:
Name Type Description
Small string Up to 160 pixels per dimension
Medium string Up to 600 pixels per dimension
Large string Up to 1500 pixels per dimension
Full string Original upload resolution (or same as EkoMediaSize.Large if image was not uploaded with fullImage set to )
Available media sizes.
Type:
  • string

(readonly) EkoErrorCode :number

Properties:
Name Type Description
BusinessError number
UnauthorizedError number Server
ItemNotFound number Server
BadRequestError number Server
Conflict number Server
ForbiddenError number Server
PermissionDenied number Server
UserIsMuted number Server
ChannelIsMuted number Server
UserIsBanned number Server
NumberOfMemberExceed number Server
ExemptFromBan number Server
MaxRepetitionExceed number Server
BanWordFound number Server
LinkNotAllowed number Server
Unknown number Client
InvalidParameter number Client
ErrorQueryInProgress number Client
ConnectionError number Client
Error codes
     - server error code pattern: 400XXX
     - client error code pattern: 800XXX
Type:
  • number