Skip to main content

TerminalAction

Struct TerminalAction 

Source
pub struct TerminalAction {
Show 20 fields pub id: Option<String>, pub device_id: Option<Option<String>>, pub deadline_duration: Option<Option<String>>, pub status: Option<String>, pub cancel_reason: Option<ActionCancelReason>, pub created_at: Option<String>, pub updated_at: Option<String>, pub app_id: Option<String>, pub location_id: Option<String>, pub type: Option<TerminalActionActionType>, pub qr_code_options: Option<Box<QrCodeOptions>>, pub save_card_options: Option<Box<SaveCardOptions>>, pub signature_options: Option<Box<SignatureOptions>>, pub confirmation_options: Option<Box<ConfirmationOptions>>, pub receipt_options: Option<Box<ReceiptOptions>>, pub data_collection_options: Option<Box<DataCollectionOptions>>, pub select_options: Option<Box<SelectOptions>>, pub device_metadata: Option<Box<DeviceMetadata>>, pub await_next_action: Option<Option<bool>>, pub await_next_action_duration: Option<Option<String>>,
}
Expand description

TerminalAction : Represents an action processed by the Square Terminal.

Fields§

§id: Option<String>

A unique ID for this TerminalAction.

§device_id: Option<Option<String>>

The unique Id of the device intended for this TerminalAction. The Id can be retrieved from /v2/devices api.

§deadline_duration: Option<Option<String>>

The duration as an RFC 3339 duration, after which the action will be automatically canceled. TerminalActions that are PENDING will be automatically CANCELED and have a cancellation reason of TIMED_OUT Default: 5 minutes from creation Maximum: 5 minutes

§status: Option<String>

The status of the TerminalAction. Options: PENDING, IN_PROGRESS, CANCEL_REQUESTED, CANCELED, COMPLETED

§cancel_reason: Option<ActionCancelReason>§created_at: Option<String>

The time when the TerminalAction was created as an RFC 3339 timestamp.

§updated_at: Option<String>

The time when the TerminalAction was last updated as an RFC 3339 timestamp.

§app_id: Option<String>

The ID of the application that created the action.

§location_id: Option<String>

The location id the action is attached to, if a link can be made.

§type: Option<TerminalActionActionType>§qr_code_options: Option<Box<QrCodeOptions>>§save_card_options: Option<Box<SaveCardOptions>>§signature_options: Option<Box<SignatureOptions>>§confirmation_options: Option<Box<ConfirmationOptions>>§receipt_options: Option<Box<ReceiptOptions>>§data_collection_options: Option<Box<DataCollectionOptions>>§select_options: Option<Box<SelectOptions>>§device_metadata: Option<Box<DeviceMetadata>>§await_next_action: Option<Option<bool>>

Indicates the action will be linked to another action and requires a waiting dialog to be displayed instead of returning to the idle screen on completion of the action. Only supported on SIGNATURE, CONFIRMATION, DATA_COLLECTION, and SELECT types.

§await_next_action_duration: Option<Option<String>>

The timeout duration of the waiting dialog as an RFC 3339 duration, after which the waiting dialog will no longer be displayed and the Terminal will return to the idle screen. Default: 5 minutes from when the waiting dialog is displayed Maximum: 5 minutes

Implementations§

Source§

impl TerminalAction

Source

pub fn new() -> TerminalAction

Represents an action processed by the Square Terminal.

Trait Implementations§

Source§

impl Clone for TerminalAction

Source§

fn clone(&self) -> TerminalAction

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TerminalAction

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TerminalAction

Source§

fn default() -> TerminalAction

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for TerminalAction

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for TerminalAction

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for TerminalAction

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for TerminalAction

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more