pub struct Response {
pub user_id: OwnedUserId,
pub access_token: String,
pub home_server: Option<OwnedServerName>,
pub device_id: OwnedDeviceId,
pub well_known: Option<DiscoveryInfo>,
pub refresh_token: Option<String>,
pub expires_in: Option<Duration>,
}
client-api-c
or client-api-s
) and (crate features client
or server
) and crate feature api
only.Expand description
Data in the response from the login
API endpoint.
Fields
user_id: OwnedUserId
The fully-qualified Matrix ID that has been registered.
access_token: String
An access token for the account.
home_server: Option<OwnedServerName>
The hostname of the homeserver on which the account has been registered.
Deprecated: Clients should instead use the user_id.server_name()
method if they require it.
device_id: OwnedDeviceId
ID of the logged-in device.
Will be the same as the corresponding parameter in the request, if one was specified.
well_known: Option<DiscoveryInfo>
Client configuration provided by the server.
If present, clients SHOULD use the provided object to reconfigure themselves.
refresh_token: Option<String>
A refresh token for the account.
This token can be used to obtain a new access token when it expires by calling the
refresh_token
endpoint.
expires_in: Option<Duration>
The lifetime of the access token, in milliseconds.
Once the access token has expired, a new access token can be obtained by using the provided refresh token. If no refresh token is provided, the client will need to re-login to obtain a new access token.
If this is None
, the client can assume that the access token will not expire.
Implementations
sourceimpl Response
impl Response
sourcepub fn new(
user_id: OwnedUserId,
access_token: String,
device_id: OwnedDeviceId
) -> Response
pub fn new(
user_id: OwnedUserId,
access_token: String,
device_id: OwnedDeviceId
) -> Response
Creates a new Response
with the given user ID, access token and device ID.
Trait Implementations
sourceimpl IncomingResponse for Response
Available on crate feature client
only.
impl IncomingResponse for Response
client
only.type EndpointError = Error
type EndpointError = Error
sourcefn try_from_http_response<T>(
response: Response<T>
) -> Result<Response, FromHttpResponseError<Error>>where
T: AsRef<[u8]>,
fn try_from_http_response<T>(
response: Response<T>
) -> Result<Response, FromHttpResponseError<Error>>where
T: AsRef<[u8]>,
http::Response
into this response type.sourceimpl OutgoingResponse for Response
Available on crate feature server
only.
impl OutgoingResponse for Response
server
only.sourcefn try_into_http_response<T>(self) -> Result<Response<T>, IntoHttpError>where
T: Default + BufMut,
fn try_into_http_response<T>(self) -> Result<Response<T>, IntoHttpError>where
T: Default + BufMut,
http::Response
. Read more