Struct ClientWrapper

pub struct ClientWrapper { /* private fields */ }

A wrapper around Client. Helps reduce external imports.

Methods from Deref<Target = Client<DynConnector, Identity>>

pub fn conf(&self) -> &Config

Returns the client’s configuration.

pub fn get_direct_thread(&self) -> GetDirectThread<C, M, R>

Constructs a fluent builder for the GetDirectThread operation.

• The fluent builder is configurable:
  • identity_id(impl Into<String>) / set_identity_id(Option<String>): A universally unique identifier.
• On success, responds with GetDirectThreadOutput with field(s):
  • thread_id(Option<String>): A universally unique identifier.
  • identity(Option<IdentityHandle>): An identity handle.
• On failure, responds with SdkError<GetDirectThreadError>

pub fn get_thread_history(&self) -> GetThreadHistory<C, M, R>

Constructs a fluent builder for the GetThreadHistory operation.

• The fluent builder is configurable:
  • thread_id(impl Into<String>) / set_thread_id(Option<String>): A universally unique identifier.
  • ts(DateTime) / set_ts(Option<DateTime>): RFC3339 timestamp.
  • count(i32) / set_count(Option<i32>): How many messages to collect in each direction. If querying rivet.api.chat.common#QueryDirection$before_and_after, rivet.api.chat.common#QueryDirection$chat_messages will be count * 2.
  • query_direction(QueryDirection) / set_query_direction(Option<QueryDirection>): Represents which direction to query messages from relative to the given timestamp.
• On success, responds with GetThreadHistoryOutput with field(s):
  • chat_messages(Option<Vec<ChatMessage>>): Ordered old to new. If querying rivet.api.chat.common#before_and_after, this will be count * 2 long.
• On failure, responds with SdkError<GetThreadHistoryError>

pub fn get_thread_topic(&self) -> GetThreadTopic<C, M, R>

Constructs a fluent builder for the GetThreadTopic operation.

• The fluent builder is configurable:
  • thread_id(impl Into<String>) / set_thread_id(Option<String>): A universally unique identifier.
• On success, responds with GetThreadTopicOutput with field(s):
  • topic(Option<ChatSimpleTopic>): Represents a topic of the given chat thread without the associated handles for the topic.
• On failure, responds with SdkError<GetThreadTopicError>

pub fn send_chat_message(&self) -> SendChatMessage<C, M, R>

Constructs a fluent builder for the SendChatMessage operation.

• The fluent builder is configurable:
  • topic(SendChatTopic) / set_topic(Option<SendChatTopic>): Topic to send a chat message to. If you already know the thread ID, use thread_id.
  • message_body(SendMessageBody) / set_message_body(Option<SendMessageBody>): Data to send in a chat message.
• On success, responds with SendChatMessageOutput with field(s):
  • chat_message_id(Option<String>): A universally unique identifier.
• On failure, responds with SdkError<SendChatMessageError>

pub fn set_thread_read(&self) -> SetThreadRead<C, M, R>

Constructs a fluent builder for the SetThreadRead operation.

• The fluent builder is configurable:
  • thread_id(impl Into<String>) / set_thread_id(Option<String>): A universally unique identifier.
  • last_read_ts(DateTime) / set_last_read_ts(Option<DateTime>): Any messages newer than this timestamp will be marked as unread. This should be the current timestamp (in milliseconds).
• On success, responds with SetThreadReadOutput
• On failure, responds with SdkError<SetThreadReadError>

pub fn set_typing_status(&self) -> SetTypingStatus<C, M, R>

Constructs a fluent builder for the SetTypingStatus operation.

• The fluent builder is configurable:
  • thread_id(impl Into<String>) / set_thread_id(Option<String>): A universally unique identifier.
  • status(ChatTypingStatus) / set_status(Option<ChatTypingStatus>): Represents a chat typing status.
• On success, responds with SetTypingStatusOutput
• On failure, responds with SdkError<SetTypingStatusError>

pub fn watch_thread(&self) -> WatchThread<C, M, R>

Constructs a fluent builder for the WatchThread operation.

• The fluent builder is configurable:
  • thread_id(impl Into<String>) / set_thread_id(Option<String>): A universally unique identifier.
  • watch_index(impl Into<String>) / set_watch_index(Option<String>): A query parameter denoting the requests watch index.
• On success, responds with WatchThreadOutput with field(s):
  • chat_messages(Option<Vec<ChatMessage>>): All messages new messages posted to this thread. Ordered old to new.
  • typing_statuses(Option<Vec<ChatIdentityTypingStatus>>): All identities that are currently typing in this thread.
  • watch(Option<WatchResponse>): Provided by watchable endpoints used in blocking loops.
• On failure, responds with SdkError<WatchThreadError>

Trait Implementations

impl Deref for ClientWrapper

type Target = Client<DynConnector, Identity>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.