Type alias TargetByPath

TargetByPath: {
    objectId?: never;
    path: string;
}

Targets an object by its location using the path. Paths are expressed relative to the structure of the object as defined by the compact view of the channel object.

Type declaration

  • Optional objectId?: never

    Not applicable when targeting by path.

  • path: string

    Use dot-separated notation (for example votes.up), relative to the channel object. An empty path "" refers to the channel object itself. Paths can contain wildcards (*) to target multiple objects at once. Wildcards match exactly one level in the channel object and can appear at the end or middle of paths (for example votes.* or posts.*.votes.up). If a key contains a dot, escape it with a backslash (for example posts.post\\.123.votes.up).

Settings

Member Visibility

Theme

Generated using TypeDoc