Struct synapse_admin_api::account_validity::renew_account::v1::Request

#[non_exhaustive]
pub struct Request<'a> {
    pub user_id: &'a UserId,
    pub expiration_ts: Option<MilliSecondsSinceUnixEpoch>,
    pub enable_renewal_emails: bool,
}

Data for a request to the renew_account_v1 API endpoint.

Extend the account validity.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

user_id: &'a UserId

user ID for the account to renew

expiration_ts: Option<MilliSecondsSinceUnixEpoch>

This is an optional parameter, it overrides the expiration date, which otherwise defaults to now + validity period configured at the server

enable_renewal_emails: bool

This is an optional parameter, it enables/disables sending renewal emails to the user. Defaults to true.

Implementations

impl<'a> Request<'a>

pub fn new(user_id: &'a UserId) -> Self

Creates an Request with the given user ID.

Trait Implementations

impl<'a> Clone for Request<'a>

fn clone(&self) -> Request<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> Outgoing for Request<'a>

type Incoming = IncomingRequest

The ‘Incoming’ variant of Self.