BTNBaseEntity Class Reference

Inherits from BTNModelObject
Conforms to BTNSubscriptable
Declared in BTNBaseEntity.h

Overview

All fields are optional and should be populated only if known.

Other Methods

– setName:

Specifies the name of the entity (location, artist, event, journey, item, etc). @note: This string may be visible in recipient applications.

- (void)setName:(NSString *)name

Discussion

Specifies the name of the entity (location, artist, event, journey, item, etc). @note: This string may be visible in recipient applications.

Declared In

BTNBaseEntity.h

– setURL:

A URL that specifies the current context. @note: This can either be a Universal Links representation of the page or URL of the canonical crawlable web page.

- (void)setURL:(NSURL *)URL

Discussion

A URL that specifies the current context. @note: This can either be a Universal Links representation of the page or URL of the canonical crawlable web page.

Declared In

BTNBaseEntity.h

Adding Third Party Identifiers

– addIdentifier:forProvider:

Adds an identifier for a third party provider to aid in mapping services.

- (void)addIdentifier:(NSString *)identifier forProvider:(NSString *)provider

Parameters

identifier

An identifier that maps to a third party service.

provider

The third party provider of the identifier. @see Known Providers below.

Discussion

Adds an identifier for a third party provider to aid in mapping services.

Declared In

BTNBaseEntity.h

Custom Context

– addCustomValue:forContextKey:

Add custom key-value pairs to further define your users context.

- (void)addCustomValue:(id)obj forContextKey:(NSString *)key

Discussion

Add custom key-value pairs to further define your users context.

Note: you can also use object subscripting (e.g. object[key] = value) @see BTNSubscriptable

Declared In

BTNBaseEntity.h