LCShortMessageRequestOptions

Objective-C

@interface LCShortMessageRequestOptions : LCDynamicObject

/**
 Time to live of validation information, in minutes. Defaults to 10 minutes.
 */
@property (nonatomic, assign) NSInteger TTL;

/**
 The representation or form of short message.
 */
@property (nonatomic, assign) LCShortMessageType type;

/**
 Token used to validate short message request.
 */
@property (nonatomic, copy, nullable) NSString *validationToken;

/**
 Template name of text short message.

 @note If not specified, the default validation message will be requested.
 */
@property (nonatomic, copy, nullable) NSString *templateName;

/**
 A set of key value pairs that will fill in template placeholders.

 @note You should not use the placeholders listed here in your template:
 `mobilePhoneNumber`, `ttl`, `smsType`, `template` and `sign`.
 */
@property (nonatomic, strong, nullable) NSDictionary *templateVariables;

/**
 Signature name of text short message.

 It will be placed ahead of text short message.
 */
@property (nonatomic, copy, nullable) NSString *signatureName;

/**
 Application name showed in validation message.

 It fills the placeholder <code>{{name}}</code> in default validation message template.
 If not given, the application name in LeanCloud console will be used.
 */
@property (nonatomic, copy, nullable) NSString *applicationName;

/**
 The operation description showed in validation message.

 It fills the placeholder <code>{{op}}</code> in default validation message template.
 */
@property (nonatomic, copy, nullable) NSString *operation;

@end

Swift

class LCShortMessageRequestOptions : LCDynamicObject

Undocumented

  • TTL

    Time to live of validation information, in minutes. Defaults to 10 minutes.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger TTL;

    Swift

    var ttl: Int { get set }
  • The representation or form of short message.

    Declaration

    Objective-C

    @property (nonatomic) LCShortMessageType type;

    Swift

    var type: LCShortMessageType { get set }
  • Token used to validate short message request.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *validationToken;

    Swift

    var validationToken: String? { get set }
  • Template name of text short message.

    Note

    If not specified, the default validation message will be requested.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *templateName;

    Swift

    var templateName: String? { get set }
  • A set of key value pairs that will fill in template placeholders.

    Note

    You should not use the placeholders listed here in your template: mobilePhoneNumber, ttl, smsType, template and sign.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSDictionary *templateVariables;

    Swift

    var templateVariables: [AnyHashable : Any]? { get set }
  • Signature name of text short message.

    It will be placed ahead of text short message.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *signatureName;

    Swift

    var signatureName: String? { get set }
  • Application name showed in validation message.

    It fills the placeholder {{name}} in default validation message template. If not given, the application name in LeanCloud console will be used.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *applicationName;

    Swift

    var applicationName: String? { get set }
  • The operation description showed in validation message.

    It fills the placeholder {{op}} in default validation message template.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *operation;

    Swift

    var operation: String? { get set }