Skip to content

Type Alias: GetAction ​

ts
type GetAction = object;

Defined in: parameters/getAction.ts:136

Type Declaration ​

display? ​

ts
optional display?: boolean;

entities? ​

ts
optional entities?: boolean;

fields? ​

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

all or a comma-separated list of action fields

id ​

ts
id: string;

The ID of the Action

member? ​

ts
optional member?: boolean;

memberCreator? ​

ts
optional memberCreator?: boolean;

Whether to include the member object for the creator of the action

memberCreatorFields? ​

ts
optional memberCreatorFields?: 
  | "id"
  | "url"
  | "username"
  | "status"
  | string & object
  | "fullName"
  | "activityBlocked"
  | "avatarHash"
  | "avatarUrl"
  | "bio"
  | "bioData"
  | "confirmed"
  | "idEnterprise"
  | "idMemberReferrer"
  | "idPremOrgsAdmin"
  | "initials"
  | "memberType"
  | "nonPublic"
  | "nonPublicAvailable"
  | "products"
  | "idBoards"
  | "idOrganizations"
  | (
  | "id"
  | "url"
  | "username"
  | "status"
  | string & object
  | "fullName"
  | "activityBlocked"
  | "avatarHash"
  | "avatarUrl"
  | "bio"
  | "bioData"
  | "confirmed"
  | "idEnterprise"
  | "idMemberReferrer"
  | "idPremOrgsAdmin"
  | "initials"
  | "memberType"
  | "nonPublic"
  | "nonPublicAvailable"
  | "products"
  | "idBoards"
  | "idOrganizations")[];

all or a comma-separated list of member fields

memberFields? ​

ts
optional memberFields?: 
  | "id"
  | "url"
  | "username"
  | "status"
  | string & object
  | "fullName"
  | "activityBlocked"
  | "avatarHash"
  | "avatarUrl"
  | "bio"
  | "bioData"
  | "confirmed"
  | "idEnterprise"
  | "idMemberReferrer"
  | "idPremOrgsAdmin"
  | "initials"
  | "memberType"
  | "nonPublic"
  | "nonPublicAvailable"
  | "products"
  | "idBoards"
  | "idOrganizations"
  | (
  | "id"
  | "url"
  | "username"
  | "status"
  | string & object
  | "fullName"
  | "activityBlocked"
  | "avatarHash"
  | "avatarUrl"
  | "bio"
  | "bioData"
  | "confirmed"
  | "idEnterprise"
  | "idMemberReferrer"
  | "idPremOrgsAdmin"
  | "initials"
  | "memberType"
  | "nonPublic"
  | "nonPublicAvailable"
  | "products"
  | "idBoards"
  | "idOrganizations")[];

all or a comma-separated list of member fields