Class JAudienceApi

Hierarchy (View Summary)

JBaseApi
- JAudienceApi

Index

Constructors

Properties

Methods

autocomplete autocompletePublishTo

Constructors

constructor

new JAudienceApi(jApi: JamespotUserApi): JAudienceApi
Parameters
- jApi: JamespotUserApi
Returns JAudienceApi
Inherited from JBaseApi.constructor
- Defined in jamespot-user-api/src/apis/base.ts:8

Properties

jApi

jApi: JamespotUserApi

network

network: Network

Methods

autocomplete

autocomplete(
query: string,
): Promise<(jObjectAutocomplete | jUserAutocomplete | jSpotAutocomplete)[]>
autocomplete return the list of user and Spot
Parameters
- query: string
Returns Promise<(jObjectAutocomplete | jUserAutocomplete | jSpotAutocomplete)[]>
- Defined in jamespot-user-api/src/apis/audience/audience.ts:12

autocompletePublishTo

autocompletePublishTo<
    T extends
        "raw-little"
        | "raw-list"
        | "raw-view"
        | undefined = "raw-little",
>(
    uris: string[],
    options?: { format: T; signal?: AbortSignal },
): PromiseApiWrapper<Audience[]>
autocompletePublishTo return the list of user and spot corresponding to the uris
Type Parameters
- T extends "raw-little" | "raw-list" | "raw-view" | undefined = "raw-little"
Parameters
- uris: string[]
- Optionaloptions: { format: T; signal?: AbortSignal }
Returns PromiseApiWrapper<Audience[]>
- Defined in jamespot-user-api/src/apis/audience/audience.ts:22