Struct AdminUsersInviteRequest 

#[non_exhaustive]
pub struct AdminUsersInviteRequest {
    pub team_id: String,
    pub email: String,
    pub channel_ids: String,
    pub custom_message: Option<String>,
    pub real_name: Option<String>,
    pub resend: Option<bool>,
    pub is_restricted: Option<bool>,
    pub is_ultra_restricted: Option<bool>,
    pub guest_expiration_ts: Option<String>,
    pub email_password_policy_enabled: Option<bool>,
}

Arguments for the Slack Web API method admin.users.invite: Invite a user to a workspace.

Send it with SlackClient::admin_users_invite.

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.

team_id: String

The ID (T1234) of the workspace.

email: String

The email address of the person to invite.

channel_ids: String

A comma-separated list of channel_ids for this user to join. At least one channel is required.

custom_message: Option<String>

An optional message to send to the user in the invite email.

real_name: Option<String>

Full name of the user.

resend: Option<bool>

Allow this invite to be resent in the future if a user has not signed up yet. Resending can only be done via the UI and has no expiration. (default: false)

is_restricted: Option<bool>

Is this user a multi-channel guest user? (default: false)

is_ultra_restricted: Option<bool>

Is this user a single channel guest user? (default: false)

guest_expiration_ts: Option<String>

Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date.

email_password_policy_enabled: Option<bool>

Allow invited user to sign in via email and password. Only available for Enterprise org teams via admin invite.

Implementations

impl AdminUsersInviteRequest

pub fn new( team_id: impl Into<String>, email: impl Into<String>, channel_ids: impl Into<String>, ) -> Self

pub fn custom_message(self, custom_message: impl Into<String>) -> Self

pub fn real_name(self, real_name: impl Into<String>) -> Self

pub fn resend(self, resend: bool) -> Self

pub fn is_restricted(self, is_restricted: bool) -> Self

pub fn is_ultra_restricted(self, is_ultra_restricted: bool) -> Self

pub fn guest_expiration_ts(self, guest_expiration_ts: impl Into<String>) -> Self

pub fn email_password_policy_enabled( self, email_password_policy_enabled: bool, ) -> Self

Trait Implementations

impl Clone for AdminUsersInviteRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AdminUsersInviteRequest

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

Formats the value using the given formatter.

impl PartialEq for AdminUsersInviteRequest

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for AdminUsersInviteRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SlackApiMethod for AdminUsersInviteRequest

const METHOD: &'static str = "admin.users.invite"

Method name, such as chat.postMessage.

type Response = AdminUsersInviteResponse

Type of a successful response.

impl StructuralPartialEq for AdminUsersInviteRequest