BranchUniversalObject

@interface BranchUniversalObject : NSObject

Use a BranchUniversalObject to describe content in your app for deep links, content analytics and indexing.

The properties object describes your content in a standard way so that it can be deep linked, shared, or indexed on spotlight for instance. You can set all the properties associated with the object and then call action methods on it to create a link or index the content on Spotlight.

  • Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCanonicalIdentifier:(nonnull NSString *)canonicalIdentifier;

    Swift

    init(canonicalIdentifier: String)
    Show on GitHub

  • Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTitle:(nonnull NSString *)title;

    Swift

    init(title: String)
    Show on GitHub

  • Undocumented

    Declaration

    Objective-C

    + (BranchUniversalObject*_Nonnull) objectWithDictionary:(NSDictionary*_Nullable)dictionary;

    Swift

    /*not inherited*/ init(dictionary: [AnyHashable : Any]?)
    Show on GitHub

  • Undocumented

    Declaration

    Objective-C

    - (NSMutableDictionary*_Nonnull) dictionary;

    Swift

    func dictionary() -> NSMutableDictionary
    Show on GitHub

  • Undocumented

    Declaration

    Objective-C

    - (NSString*_Nonnull) description;

    Swift

    func description() -> String
    Show on GitHub

  • An identifier that canonically identifies this content item, like an ISBN number or SKU.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) NSString *canonicalIdentifier;

    Swift

    var canonicalIdentifier: String? { get set }
    Show on GitHub

  • A web URL that canonically locates this content item

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) NSString *canonicalUrl;

    Swift

    var canonicalUrl: String? { get set }
    Show on GitHub

  • The title or name of this content item.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) NSString *title;

    Swift

    var title: String? { get set }
    Show on GitHub

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSString *contentDescription

    Swift

    var contentDescription: String? { get set }
    Show on GitHub

  • A URL to an image that should be associated with the item

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) NSString *imageUrl;

    Swift

    var imageUrl: String? { get set }
    Show on GitHub

  • An array of keywords that describe the item.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) NSArray<NSString *> *keywords;

    Swift

    var keywords: [String]? { get set }
    Show on GitHub

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSDate   *creationDate

    Swift

    var creationDate: Date? { get set }
    Show on GitHub

  • The date that a link to this item is no longer relevant

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) NSDate *expirationDate;

    Swift

    var expirationDate: Date? { get set }
    Show on GitHub

  • Index the content on Spotlight.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL locallyIndex;

    Swift

    var locallyIndex: Bool { get set }
    Show on GitHub

  • Index on Google, Branch, etc.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL publiclyIndex;

    Swift

    var publiclyIndex: Bool { get set }
    Show on GitHub

  • Properties that further describe your content.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nonnull)
    BranchContentMetadata *contentMetadata;

    Swift

    var contentMetadata: BranchContentMetadata { get set }
    Show on GitHub