Type Alias ClientUpdateEventWritable

Type declaration

• Optionalpayload?: {
      client?: Types.Client;
      conversation?: ConversationTruncated;
      reason?: "confirmed" | "blocked" | "unblocked" | "matched";
      user?: UserTruncatedWritable;
  }

  The payload of the event. The contents of this object depend on the type of event.

  • Optionalclient?: Types.Client

    The updated client.

  • Optionalconversation?: ConversationTruncated

    The conversation which triggered a change in the client.

  • Optionalreason?: "confirmed" | "blocked" | "unblocked" | "matched"

    The reason for which the client was updated.

    • confirmed - The client is now active and ready to use.
    • blocked - The user has unsubscribed from the conversation.
    • unblocked - A previously unsubscribed user resubscribed to the conversation.
    • matched - The channel found a user that matches the information provided.

  • Optionaluser?: UserTruncatedWritable

    The user associated with the client.