Class RemoteAgentClient<TypingsSchema>

Type Parameters

TypingsSchema extends Record<string, unknown> = Record<string, unknown>

Hierarchy

default
- RemoteAgentClient

Index

Constructors

constructor

new RemoteAgentClient<
    TypingsSchema extends Record<string, unknown> = Record<string, unknown>,
>(
    params?: {
        actionEndpoints?: ActionEndpointsByCollection;
        httpRequester: HttpRequester;
        overridePermissions?: (permissions: PermissionsOverride) => Promise<void>;
    },
): RemoteAgentClient<TypingsSchema>
Type Parameters
- TypingsSchema extends Record<string, unknown> = Record<string, unknown>
Parameters
- Optionalparams: {
      actionEndpoints?: ActionEndpointsByCollection;
      httpRequester: HttpRequester;
      overridePermissions?: (permissions: PermissionsOverride) => Promise<void>;
  }
Returns RemoteAgentClient<TypingsSchema>
Overrides Chart.constructor
- Defined in domains/remote-agent-client.ts:44

Properties

`Protected` `Optional`actionEndpoints

actionEndpoints?: ActionEndpointsByCollection

`Protected`httpRequester

httpRequester: HttpRequester

Methods

clearPermissionOverride

clearPermissionOverride(): Promise<void>
Returns Promise<void>
- Defined in domains/remote-agent-client.ts:83

collection

collection(name: CollectionName<TypingsSchema>): Collection
Parameters
- name: CollectionName<TypingsSchema>
Returns Collection
- Defined in domains/remote-agent-client.ts:87

distributionChart

distributionChart(chartName: string): Promise<DistributionChart>
Parameters
- chartName: string
Returns Promise<DistributionChart>
Inherited from Chart.distributionChart
- Defined in domains/chart.ts:28

leaderboardChart

leaderboardChart(chartName: string): Promise<LeaderboardChart>
Parameters
- chartName: string
Returns Promise<LeaderboardChart>
Inherited from Chart.leaderboardChart
- Defined in domains/chart.ts:40

`Protected`loadChart

loadChart<Type>(
chartName: string,
body?: Record<string, unknown>,
): Promise<Type>
Type Parameters
- Type
Parameters
- chartName: string
- Optionalbody: Record<string, unknown>
Returns Promise<Type>
Inherited from Chart.loadChart
- Defined in domains/chart.ts:48

objectiveChart

objectiveChart(chartName: string): Promise<ObjectiveChart>
Parameters
- chartName: string
Returns Promise<ObjectiveChart>
Inherited from Chart.objectiveChart
- Defined in domains/chart.ts:36

overrideActionPermission

overrideActionPermission(
    collectionName: CollectionName<TypingsSchema>,
    actionName: string,
    permissions: SmartActionPermissionsOverride,
): Promise<void>
Parameters
- collectionName: CollectionName<TypingsSchema>
- actionName: string
- permissions: SmartActionPermissionsOverride
Returns Promise<void>
- Defined in domains/remote-agent-client.ts:68

overrideCollectionPermission

overrideCollectionPermission(
collectionName: CollectionName<TypingsSchema>,
permissions: CollectionPermissionsOverride,
): Promise<void>
Parameters
- collectionName: CollectionName<TypingsSchema>
- permissions: CollectionPermissionsOverride
Returns Promise<void>
- Defined in domains/remote-agent-client.ts:56

percentageChart

percentageChart(chartName: string): Promise<number>
Parameters
- chartName: string
Returns Promise<number>
Inherited from Chart.percentageChart
- Defined in domains/chart.ts:32

timeBasedChart

timeBasedChart(chartName: string): Promise<TimeBasedChart>
Parameters
- chartName: string
Returns Promise<TimeBasedChart>
Inherited from Chart.timeBasedChart
- Defined in domains/chart.ts:44

valueChart

valueChart(chartName: string): Promise<ValueChart>
Parameters
- chartName: string
Returns Promise<ValueChart>
Inherited from Chart.valueChart
- Defined in domains/chart.ts:24

Class RemoteAgentClient<TypingsSchema>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RemoteAgentClient<TypingsSchema>

Properties

Protected OptionalactionEndpoints

ProtectedhttpRequester

Methods

clearPermissionOverride

Returns Promise<void>

collection

Parameters

Returns Collection

distributionChart

Parameters

Returns Promise<DistributionChart>

leaderboardChart

Parameters

Returns Promise<LeaderboardChart>

ProtectedloadChart

Type Parameters

Parameters

Returns Promise<Type>

objectiveChart

Parameters

Returns Promise<ObjectiveChart>

overrideActionPermission

Parameters

Returns Promise<void>

overrideCollectionPermission

Parameters

Returns Promise<void>

percentageChart

Parameters

Returns Promise<number>

timeBasedChart

Parameters

Returns Promise<TimeBasedChart>

valueChart

Parameters

Returns Promise<ValueChart>

Settings

On This Page

`Protected` `Optional`actionEndpoints

`Protected`httpRequester

`Protected`loadChart