Struct AtpAgent

pub struct AtpAgent<S, T>
where
    S: AtpSessionStore + Send + Sync,
    T: XrpcClient + Send + Sync,
    S::Error: Error + Send + Sync + 'static,
{ /* private fields */ }

Available on crate feature agent only.

An ATP “Agent”. Manages session token lifecycles and provides convenience methods.

This will be deprecated in the near future. Use Agent directly with a CredentialSession instead:

Example

use atrium_api::agent::atp_agent::{store::MemorySessionStore, CredentialSession};
use atrium_api::agent::Agent;
use atrium_xrpc_client::reqwest::ReqwestClient;

let session = CredentialSession::new(
    ReqwestClient::new("https://bsky.social"),
    MemorySessionStore::default(),
);
let agent = Agent::new(session);

Implementations

impl<S, T> AtpAgent<S, T>

where S: AtpSessionStore + Send + Sync, T: XrpcClient + Send + Sync, S::Error: Error + Send + Sync + 'static,

pub fn new(xrpc: T, store: S) -> Self

Create a new agent.

pub async fn login( &self, identifier: impl AsRef<str>, password: impl AsRef<str>, ) -> Result<AtpSession, Error<Error>>

Start a new session with this agent.

pub async fn resume_session( &self, session: AtpSession, ) -> Result<(), Error<Error>>

pub async fn get_session(&self) -> Option<AtpSession>

Get the current session.

pub async fn get_endpoint(&self) -> String

Get the current endpoint.

pub async fn get_labelers_header(&self) -> Option<Vec<String>>

Get the current labelers header.

pub async fn get_proxy_header(&self) -> Option<String>

Get the current proxy header.

Methods from Deref<Target = Agent<Wrapper<CredentialSession<S, T>>>>

pub async fn did(&self) -> Option<Did>

Returns the DID of the current session.

pub fn api_with_proxy( &self, did: Did, service_type: impl AsRef<str>, ) -> Service<Wrapper<M>>

Configures the atproto-proxy header to be applied on requests.

Returns a new client service with the proxy header configured.

Trait Implementations

impl<S, T> Deref for AtpAgent<S, T>

where S: AtpSessionStore + Send + Sync, T: XrpcClient + Send + Sync, S::Error: Error + Send + Sync + 'static,

type Target = Agent<Wrapper<CredentialSession<S, T>>>

The resulting type after dereferencing.

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

Dereferences the value.