SBSDKGenericDocumentFieldType

@interface SBSDKGenericDocumentFieldType : NSObject

A generic documents field type.

  • Local field type name scoped to the containing document type

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSString *name;

    Swift

    var name: String { get set }

  • Unique global field type name prefixed with the document types of all containing documents

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSString *fullName;

    Swift

    var fullName: String { get set }

  • Normalized global field type name. Fields in document types derived from the same base document type in the schema will have the same normalized name.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSString *normalizedName;

    Swift

    var normalizedName: String { get set }

  • Optional common field type. Commonly occurring fields that have the same semantic meaning in different document types will often have a set common type.

    Declaration

    Objective-C

    @property (nonatomic) SBSDKGenericDocumentCommonFieldType commonType;

    Swift

    var commonType: SBSDKGenericDocumentCommonFieldType { get set }

  • The friendly, human readable display name of this field in English. Can be customized using the function setUserFieldTypeDisplayTexts. This computed property first looks up the display text for the receiver in the userFieldTypeDisplayTexts dictionary. If there is no value stored, or the user dictionary is nil, it automatically falls back to the defaultFieldTypeDisplayTexts dictionary.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *displayText;

    Swift

    var displayText: String? { get }

  • A dictionary of the default display strings for generic document field types. Each key is equal to a fields normalizedName property. The values contain the default display texts for the corresponding fields.

    Declaration

    Objective-C

    + (nonnull NSDictionary<NSString *, NSString *> *)defaultFieldTypeDisplayTexts;

    Swift

    class func defaultFieldTypeDisplayTexts() -> [String : String]

  • A dictionary of user defined display strings for generic document field types. Defaults to nil. Each key is equal to a fields normalizedName property. The values contain the user defined display texts for the corresponding fields.

    Declaration

    Objective-C

    + (nullable NSDictionary<NSString *, NSString *> *)userFieldTypeDisplayTexts;

    Swift

    class func userFieldTypeDisplayTexts() -> [String : String]?

  • Sets a dictionary of user defined display strings. Used to specify user defined text for displaying documents field types in the user interface.

    Declaration

    Objective-C

    + (void)setUserFieldTypeDisplayTexts:
    (nullable NSDictionary<NSString *, NSString *> *)userFieldTypeDisplayTexts;

    Swift

    class func setUserFieldTypeDisplayTexts(_ userFieldTypeDisplayTexts: [String : String]?)

  • A dictionary of the default visibility states for generic document field types. Each key is equal to a fields normalizedName property. The values contain the state of visibility for the corresponding fields.

    Declaration

    Objective-C

    + (nonnull NSDictionary<NSString *, SBSDKGenericDocumentFieldDisplayState> *)
    defaultFieldTypeVisibilities;

    Swift

    class func defaultFieldTypeVisibilities() -> [String : String]

  • A dictionary of user defined visibility states for generic document field types. Defaults to nil. Each key is equal to a fields normalizedName property. The values contain the state of visibility for the corresponding fields.

    Declaration

    Objective-C

    + (nullable NSDictionary<NSString *, SBSDKGenericDocumentFieldDisplayState> *)
    userFieldTypeVisibilities;

    Swift

    class func userFieldTypeVisibilities() -> [String : String]?

  • Sets a dictionary of user defined visibility states. Used to specify user defined visibility of documents field types in the user interface.

    Declaration

    Objective-C

    + (void)setUserFieldTypeVisibilities:
    (nullable NSDictionary<NSString *, SBSDKGenericDocumentFieldDisplayState> *)
        userFieldTypeVisibilities;

    Swift

    class func setUserFieldTypeVisibilities(_ userFieldTypeVisibilities: [String : String]?)