DBSHARINGInsufficientPlan

Objective-C

@interface DBSHARINGInsufficientPlan : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGInsufficientPlan : NSObject, DBSerializable, NSCopying

The InsufficientPlan struct.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

Instance fields

  • A message to tell the user to upgrade in order to support expected action.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull message;

    Swift

    var message: String { get }

  • A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *upsellUrl;

    Swift

    var upsellUrl: String? { get }

Constructors

  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithMessage:(nonnull NSString *)message
                              upsellUrl:(nullable NSString *)upsellUrl;

    Swift

    init(message: String, upsellUrl: String?)

    Parameters

    message

    A message to tell the user to upgrade in order to support expected action.
    upsellUrl

    A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade.

    Return Value

    An initialized instance.

  • Convenience constructor (exposes only non-nullable instance variables with no default value).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithMessage:(nonnull NSString *)message;

    Swift

    init(message: String)

    Parameters

    message

    A message to tell the user to upgrade in order to support expected action.

    Return Value

    An initialized instance.