Skip to main content

ChannelLinkRequest

compose_channels::wire::types

Struct ChannelLinkRequest

pub struct ChannelLinkRequest {
    pub agent_name: Option<String>,
    pub agent_wallet: String,
    pub hai_id: Option<String>,
    pub mode: ChannelLinkRequestMode,
    pub privacy: ChannelLinkRequestPrivacy,
    pub scope: Option<ChannelScope>,
    pub user_address: Option<String>,
}

Expand description

ChannelLinkRequest

JSON schema

{
 "type": "object",
 "required": [
   "agentWallet"
 ],
 "properties": {
   "agentName": {
     "description": "Display name for the agent on the channel",
     "type": "string"
   },
   "agentWallet": {
     "description": "Agent wallet address to link",
     "type": "string"
   },
   "haiId": {
     "description": "Required when scope is local.",
     "type": "string"
   },
   "mode": {
     "description": "Linking mode (guild for Slack/Discord server-level linking)",
     "default": "user",
     "type": "string",
     "enum": [
       "user",
       "guild"
     ]
   },
   "privacy": {
     "default": "public",
     "type": "string",
     "enum": [
       "public",
       "private"
     ]
   },
   "scope": {
     "$ref": "#/components/schemas/ChannelScope"
   },
   "userAddress": {
     "description": "User wallet address (inferred from x-session-user-address header if omitted)",
     "type": "string"
   }
 }
}

Fields§

§agent_name: Option<String>

Display name for the agent on the channel

§agent_wallet: String

Agent wallet address to link

§hai_id: Option<String>

Required when scope is local.

§mode: ChannelLinkRequestMode

Linking mode (guild for Slack/Discord server-level linking)

§privacy: ChannelLinkRequestPrivacy§scope: Option<ChannelScope>§user_address: Option<String>

User wallet address (inferred from x-session-user-address header if omitted)

Implementations§

impl ChannelLinkRequest

pub fn builder() -> ChannelLinkRequest

Trait Implementations§

impl Clone for ChannelLinkRequest

fn clone(&self) -> ChannelLinkRequest

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for ChannelLinkRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for ChannelLinkRequest

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl From<ChannelLinkRequest> for ChannelLinkRequest

fn from(value: ChannelLinkRequest) -> Self

Converts to this type from the input type.

impl Serialize for ChannelLinkRequest

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl TryFrom<ChannelLinkRequest> for ChannelLinkRequest

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: ChannelLinkRequest) -> Result<Self, ConversionError>

Performs the conversion.

Auto Trait Implementations§

impl Freeze for ChannelLinkRequest

impl RefUnwindSafe for ChannelLinkRequest

impl Send for ChannelLinkRequest

impl Sync for ChannelLinkRequest

impl Unpin for ChannelLinkRequest

impl UnsafeUnpin for ChannelLinkRequest

impl UnwindSafe for ChannelLinkRequest

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more