Skip to content

Interface: Identity

Defined in: schema.ts:1011

The runtime version of IdentityDefinition with the current Pack ID injected if a different one isn't set by the maker.

Extends

Properties

attribution?

optional attribution: AttributionNode[]

Defined in: schema.ts:1004

Deprecated

See ObjectSchemaDefinition.attribution

Inherited from

IdentityDefinition.attribution


dynamicUrl?

optional dynamicUrl: string

Defined in: schema.ts:992

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


name

name: string

Defined in: schema.ts:980

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


packId

packId: number

Defined in: schema.ts:1012

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

Overrides

IdentityDefinition.packId