Class Groups

Index

Constructors

Methods

create get getAll getFilter getFilterNative getSettings removeFilter updateSettings

Constructors

constructor

new Groups(saasClient): Groups
Parameters
- saasClient: QlikSaaSClient
Returns Groups
- Defined in modules/Groups.ts:35

Methods

create

create(arg): Promise<Group>
Parameters
- arg: IGroupCreate
Returns Promise<Group>
- Defined in modules/Groups.ts:122

get

get(arg): Promise<Group>
Parameters
- arg: {
  id: string;
  }
  - id: string
Returns Promise<Group>
- Defined in modules/Groups.ts:39

getAll

getAll(): Promise<Group[]>
Returns Promise<Group[]>
- Defined in modules/Groups.ts:87

getFilter

getFilter(arg): Promise<Group[]>
Parameters
- arg: {
  filter: string;
  }
  - filter: string
Returns Promise<Group[]>
- Defined in modules/Groups.ts:60

getFilterNative

getFilterNative(arg): Promise<IGroup[]>
Parameters
- arg: {
  filter: string;
  sort?: string;
  }
  - filter: string
  - Optional sort?: string
Returns Promise<IGroup[]>
- Defined in modules/Groups.ts:48

getSettings

getSettings(): Promise<IGroupSettings>
Returns Promise<IGroupSettings>
- Defined in modules/Groups.ts:94

removeFilter

removeFilter(arg): Promise<{
id: string;
status: number;
}[]>
Parameters
- arg: {
  filter: string;
  }
  - filter: string
Returns Promise<{
id: string;
status: number;
}[]>
- Defined in modules/Groups.ts:74

updateSettings

updateSettings(arg): Promise<number>
Parameters
- arg: IGroupSettingsUpdate[]
Returns Promise<number>
- Defined in modules/Groups.ts:100