Header menu logo FsCDK

SmsSubscriptionBuilder Type

Constructors

Constructor Description

SmsSubscriptionBuilder()

Full Usage: SmsSubscriptionBuilder()

Returns: SmsSubscriptionBuilder
Returns: SmsSubscriptionBuilder

Instance members

Instance member Description

this.Combine

Full Usage: this.Combine

Parameters:
Returns: SmsSubscriptionConfig
state1 : SmsSubscriptionConfig
state2 : SmsSubscriptionConfig
Returns: SmsSubscriptionConfig

deadLetterQueue queue

Full Usage: deadLetterQueue queue

Parameters:
    queue : IQueue - The SQS queue to use as DLQ.

Returns: SmsSubscriptionConfig

Sets a dead-letter queue for failed messages.

queue : IQueue

The SQS queue to use as DLQ.

Returns: SmsSubscriptionConfig

this.Delay

Full Usage: this.Delay

Parameters:
Returns: SmsSubscriptionConfig
Modifiers: inline
f : unit -> SmsSubscriptionConfig
Returns: SmsSubscriptionConfig

filterPolicy policy

Full Usage: filterPolicy policy

Parameters:
Returns: SmsSubscriptionConfig

Sets a filter policy for the subscription.

policy : IDictionary<string, SubscriptionFilter>

The filter policy dictionary.

Returns: SmsSubscriptionConfig

filterPolicyWithMessageBody policy

Full Usage: filterPolicyWithMessageBody policy

Parameters:
Returns: SmsSubscriptionConfig

Sets a filter policy with message body for the subscription.

policy : IDictionary<string, FilterOrPolicy>

The filter policy with message body dictionary.

Returns: SmsSubscriptionConfig

this.For

Full Usage: this.For

Parameters:
Returns: SmsSubscriptionConfig
Modifiers: inline
config : SmsSubscriptionConfig
f : unit -> SmsSubscriptionConfig
Returns: SmsSubscriptionConfig

phoneNumber number

Full Usage: phoneNumber number

Parameters:
    number : string - The phone number to subscribe (E.164 format recommended).

Returns: SmsSubscriptionConfig

Sets the phone number for the subscription.

number : string

The phone number to subscribe (E.164 format recommended).

Returns: SmsSubscriptionConfig

this.Run

Full Usage: this.Run

Parameters:
Returns: ITopicSubscription
config : SmsSubscriptionConfig
Returns: ITopicSubscription

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: SmsSubscriptionConfig
() : unit
Returns: SmsSubscriptionConfig

this.Zero

Full Usage: this.Zero

Returns: SmsSubscriptionConfig
Returns: SmsSubscriptionConfig

Type something to start searching.