Class Agents

The brand's agent roster. Returns the brokerage's users — see IUser.

Requests are routed through the portal proxy, which resolves the brand from the portal. On a hostname with no registered portal these methods reject with the discovery error.

Index

Constructors

Methods

get list search

Constructors

constructor

new Agents(portalReady: Promise<PortalInfo>): Agents
Parameters
- portalReady: Promise<PortalInfo>
Returns Agents

Methods

get

get(id: string): Promise<IUser>
Fetches a single roster member by user id.
Parameters
- id: string
Returns Promise<IUser>

list

list(params?: IAgentsListParams): Promise<IAgentsListResult>
Fetches the brand's agent roster.
Parameters
- params: IAgentsListParams = {}
Returns Promise<IAgentsListResult>

search

search(params: { limit?: number; q: string }): Promise<IAgentsListResult>
Autocomplete-friendly roster search: a small result set by default, and failures resolve to an empty list so a typeahead never tears the page down. Use Agents.list when errors should surface.
Parameters
- params: { limit?: number; q: string }
Returns Promise<IAgentsListResult>