Type Alias: GetMemberActions

type GetMemberActions = object;

Defined in: parameters/getMemberActions.ts:62

Type Declaration

before?

optional before?: string;

A date string in the form of YYYY-MM-DDThh:mm:ssZ or a mongo object ID. Only objects created before this date will be returned.

entities?

optional entities?: boolean;

Whether to return the entities of each action.

fields?

optional fields?: 
  | "type"
  | "data"
  | "id"
  | "display"
  | string & object
  | "date"
  | "limits"
  | "idMemberCreator"
  | "memberCreator"
  | (
  | "type"
  | "data"
  | "id"
  | "display"
  | string & object
  | "date"
  | "limits"
  | "idMemberCreator"
  | "memberCreator")[];

The fields to be returned for the Actions. See Action fields here.

filter?

optional filter?: string | string[];

A comma-separated list of action types.

format?

optional format?: string;

The format of the returned Actions. Either list or count.

id

id: string;

The ID or username of the member

idModels?

optional idModels?: string | string[];

A comma-separated list of idModels. Only actions related to these models will be returned.

limit?

optional limit?: number;

The limit of the number of responses, between 0 and 1000.

member?

optional member?: boolean;

Whether to return the member object for each action.

memberCreator?

optional memberCreator?: boolean;

Whether to return the memberCreator object for each action.

memberCreatorFields?

optional memberCreatorFields?: string | string[];

The fields of the member creator to return

memberFields?

optional memberFields?: string | string[];

The fields of the member to return.

page?

optional page?: number;

The page of results for actions.

reactions?

optional reactions?: boolean;

Whether to show reactions on comments or not.

since?

optional since?: string;

A date string in the form of YYYY-MM-DDThh:mm:ssZ or a mongo object ID. Only objects created since this date will be returned.