Skip to content

Interface: Identity

The runtime version of IdentityDefinition with a pack ID injected.

Hierarchy

Identity

Properties

attribution

Optional attribution: AttributionNode[]

Attribution text, images, and/or links that should be rendered along with this value.

See makeAttributionNode.

Inherited from

IdentityDefinition.attribution

Defined in

schema.ts:635


dynamicUrl

Optional dynamicUrl: string

The dynamic URL, if this is a schema for a dynamic sync table. When returning a schema from the DynamicSyncTableOptions.getSchema formula of a dynamic sync table, you must include the dynamic URL of that table, so that rows in this table may be distinguished from rows in another dynamic instance of the same table.

When creating a reference to a dynamic sync table, you must include the dynamic URL of the table you wish to reference, again to distinguish which table instance you are trying to reference.

Inherited from

IdentityDefinition.dynamicUrl

Defined in

schema.ts:629


name

name: string

The name of this entity. This is an arbitrary name but should be unique within your pack. For example, if you are defining a schema that represents a user object, "User" would be a good identity name.

Inherited from

IdentityDefinition.name

Defined in

schema.ts:617


packId

packId: number

The ID of another pack, if you are trying to reference a value from different pack.

Overrides

IdentityDefinition.packId

Defined in

schema.ts:642