AppAddress

AppAddress = { calendar?: CalendarView; display?: string; filter?: string; filterLayout?: FilterLayout; kind: "list"; list?: string; map?: MapView; orderBy?: string; resource: string; savedSearch?: string; } | { edit?: boolean; key: KeyValue | readonly KeyValue[]; kind: "record"; open?: readonly string[]; resource: string; } | { kind: "create"; resource: string; values?: Readonly<Record<string, string>>; } | { kind: "page"; page: string; }

Defined in: packages/schema/src/model.ts:203

A place in the app: a resource’s list, one of its records, its create form, or a composed page. A record’s key is its one value or its parts, as the record API takes them; readAppPath gives it back as the API’s text form. A create form’s values fill in fields of the new record by name, as text ({ listing_id: '42' }). A list’s map is where its map display looks, and its calendar the month or week its calendar display shows. See Addresses.

Union Members

Type Literal

{ calendar?: CalendarView; display?: string; filter?: string; filterLayout?: FilterLayout; kind: "list"; list?: string; map?: MapView; orderBy?: string; resource: string; savedSearch?: string; }

calendar?

optional calendar?: CalendarView

The month or week its calendar display shows.

display?

optional display?: string

The display the list shows in, by name; its default when omitted.

filter?

optional filter?: string

An AIP-160 filter on the list.

filterLayout?

optional filterLayout?: FilterLayout

Where its filters sit.

kind

kind: "list"

A resource’s list.

list?

optional list?: string

A named list of the resource’s view (.namedList(...)); its own list when omitted.

map?

optional map?: MapView

Where its map display looks.

orderBy?

optional orderBy?: string

An AIP-132 order of the list.

resource

resource: string

The resource listed.

savedSearch?

optional savedSearch?: string

The saved search the list was opened from, by its key in the text form the record API takes: while the list’s filter differs from the search’s, the list offers to update the search.

---

Type Literal

{ edit?: boolean; key: KeyValue | readonly KeyValue[]; kind: "record"; open?: readonly string[]; resource: string; }

edit?

optional edit?: boolean

The record’s form, on a view whose record page opens as a read view or locked (.recordMode(...)): the page that Edit opens. A view whose record page is always editable ignores it.

key

key: KeyValue | readonly KeyValue[]

The record’s key: its value, or its parts for a composite key.

kind

kind: "record"

One record.

open?

optional open?: readonly string[]

The titles of the record page’s collapsed groups that are open.

resource

resource: string

The record’s resource.

---

Type Literal

{ kind: "create"; resource: string; values?: Readonly<Record<string, string>>; }

kind

kind: "create"

The form for a new record.

resource

resource: string

The resource the record is created in.

values?

optional values?: Readonly<Record<string, string>>

Fields of the new record filled in by name, as text; a start the person can change.

---

Type Literal

{ kind: "page"; page: string; }

kind

kind: "page"

A composed page.

page

page: string

The page’s name.