SBSDKGenericDocumentType

@interface SBSDKGenericDocumentType : NSObject

A generic documents type.

  • Local document type name.

    Declaration

    Objective-C

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

    Swift

    var name: String { get set }

  • Unique global document 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 document type name. Common document types appearing as child documents in different places will often have the same normalized type name.

    Declaration

    Objective-C

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

    Swift

    var normalizedName: String { get set }

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

    Declaration

    Objective-C

    - (nullable NSString *)displayText;

    Swift

    func displayText() -> String?

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

    Declaration

    Objective-C

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

    Swift

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

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

    Declaration

    Objective-C

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

    Swift

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

  • Sets a dictionary of user defined display strings. Used to specify user defined text for displaying a document type in the user interface.

    Declaration

    Objective-C

    + (void)setUserDocumentTypeDisplayTexts:
    (nullable NSDictionary<NSString *, NSString *> *)userDocumentTypeTexts;

    Swift

    class func setUserDocumentTypeDisplayTexts(_ userDocumentTypeTexts: [String : String]?)