pub struct Response {
pub access_token: Option<String>,
pub user_id: OwnedUserId,
pub device_id: Option<OwnedDeviceId>,
pub refresh_token: Option<String>,
pub expires_in: Option<Duration>,
}
client
or server
only.Expand description
Data in the response from the register
API endpoint.
Fields
access_token: Option<String>
An access token for the account.
This access token can then be used to authorize other requests.
Required if the request’s inhibit_login
was set to false
.
user_id: OwnedUserId
The fully-qualified Matrix ID that has been registered.
device_id: Option<OwnedDeviceId>
ID of the registered device.
Will be the same as the corresponding parameter in the request, if one was specified.
Required if the request’s inhibit_login
was set to false
.
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.
Omitted if the request’s inhibit_login
was set to true
.
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.
Omitted if the request’s inhibit_login
was set to true
.
Implementations
sourceimpl Response
impl Response
sourcepub fn new(user_id: OwnedUserId) -> Self
pub fn new(user_id: OwnedUserId) -> Self
Creates a new Response
with the given user ID.
Trait Implementations
sourceimpl IncomingResponse for Response
Available on crate feature client
only.
impl IncomingResponse for Response
client
only.type EndpointError = UiaaResponse
type EndpointError = UiaaResponse
sourcefn try_from_http_response<T: AsRef<[u8]>>(
response: Response<T>
) -> Result<Self, FromHttpResponseError<UiaaResponse>>
fn try_from_http_response<T: AsRef<[u8]>>(
response: Response<T>
) -> Result<Self, FromHttpResponseError<UiaaResponse>>
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: Default + BufMut>(
self
) -> Result<Response<T>, IntoHttpError>
fn try_into_http_response<T: Default + BufMut>(
self
) -> Result<Response<T>, IntoHttpError>
http::Response
. Read more