Interface INetworkService

moveSyncInterval

generateMessageId

• generateMessageId(): string

• Generate a message ID.

  Returns string

off

• off<T>(event, listener): EventHandler

• Unsubscribe from a specific event.

  Type Parameters

  • T extends keyof INetworkServiceEvents

  Parameters

  • event: T

    Event name
  • listener: INetworkServiceEvents[T]

    Callback function

  Returns EventHandler

on

• on<T>(event, listener): EventHandle

• Subscribe to a specific event.

  Type Parameters

  • T extends keyof INetworkServiceEvents

  Parameters

  • event: T

    Event name
  • listener: INetworkServiceEvents[T]

    Callback function

  Returns EventHandle

sendMessage

• sendMessage<T>(data, options?): string

• Send custom message.

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • data: T
  • Optionaloptions: {
        batch?: boolean;
        entityId?: string;
        messageId?: string;
    }

    Other options.

    • Optionalbatch?: boolean

      Batch processing of messages: If set to true, the messages will be cached and sent together later.

    • OptionalentityId?: string

      Entity GUID: Specifies the entity that can receive the message through the receive:message event.

    • OptionalmessageId?: string

      Message ID: Used to override messages with the same ID that have not been sent yet.

  Returns string

  • Message ID.