Class default

Index

Constructors

Methods

getAnimal getAnimalQualification getAnimalQualifications getAnimals getHandlerQualification getHandlerQualifications getIncident getIncidents getMember getMemberAwards getMemberGroup getMemberGroups getMemberQualification getMemberQualifications getMembers updateCustomFields updateMember

Constructors

constructor

new default(token: string): default
Parameters
- token: string
Returns default
- Defined in d4h.ts:103

Methods

getAnimal

getAnimal(
    context: string,
    contextId: number,
    id: number | "me",
): Promise<Animal>
Parameters
- context: string
- contextId: number
- id: number | "me"
Returns Promise<Animal>
- Defined in d4h.ts:142

getAnimalQualification

getAnimalQualification(
    context: string,
    contextId: number,
    id: number,
): Promise<Qualification>
Parameters
- context: string
- contextId: number
- id: number
Returns Promise<Qualification>
- Defined in d4h.ts:281

getAnimalQualifications

getAnimalQualifications(
    context: string,
    contextId: number,
    options?: GetQualificationOptions,
): Promise<Qualification[]>
Parameters
- context: string
- contextId: number
- Optionaloptions: GetQualificationOptions
Returns Promise<Qualification[]>
- Defined in d4h.ts:289

getAnimals

getAnimals(
    context: string,
    contextId: number,
    options?: GetAnimalsOptions,
): Promise<Animal[]>
Parameters
- context: string
- contextId: number
- Optionaloptions: GetAnimalsOptions
Returns Promise<Animal[]>
- Defined in d4h.ts:150

getHandlerQualification

getHandlerQualification(
    context: string,
    contextId: number,
    id: number,
): Promise<Qualification>
Parameters
- context: string
- contextId: number
- id: number
Returns Promise<Qualification>
- Defined in d4h.ts:297

getHandlerQualifications

getHandlerQualifications(
    context: string,
    contextId: number,
    options?: GetQualificationOptions,
): Promise<Qualification[]>
Parameters
- context: string
- contextId: number
- Optionaloptions: GetQualificationOptions
Returns Promise<Qualification[]>
- Defined in d4h.ts:305

getIncident

getIncident(
    context: string,
    contextId: number,
    activityId: number,
): Promise<Incident>
Parameters
- context: string
- contextId: number
- activityId: number
Returns Promise<Incident>
- Defined in d4h.ts:188

getIncidents

getIncidents(
    context: string,
    contextId: number,
    options?: GetIncidentOptions,
): Promise<Incident[]>
Parameters
- context: string
- contextId: number
- Optionaloptions: GetIncidentOptions
Returns Promise<Incident[]>
- Defined in d4h.ts:201

getMember

getMember(
    context: string,
    contextId: number,
    id: number | "me",
    options?: GetMemberOptions,
): Promise<Member>
Parameters
- context: string
- contextId: number
- id: number | "me"
- Optionaloptions: GetMemberOptions
Returns Promise<Member>
- Defined in d4h.ts:111

getMemberAwards

getMemberAwards(
    context: string,
    contextId: number,
    options?: GetMemberAwardsOptions,
): Promise<MemberAwards[]>
Parameters
- context: string
- contextId: number
- Optionaloptions: GetMemberAwardsOptions
Returns Promise<MemberAwards[]>
- Defined in d4h.ts:313

getMemberGroup

getMemberGroup(
    context: string,
    contextId: number,
    groupId: number,
): Promise<memberGroup>
Parameters
- context: string
- contextId: number
- groupId: number
Returns Promise<memberGroup>
- Defined in d4h.ts:168

getMemberGroups

getMemberGroups(
    context: string,
    contextId: number,
    options?: GetMemberGroupsOptions,
): Promise<memberGroup[]>
Parameters
- context: string
- contextId: number
- Optionaloptions: GetMemberGroupsOptions
Returns Promise<memberGroup[]>
- Defined in d4h.ts:176

getMemberQualification

getMemberQualification(
    context: string,
    contextId: number,
    id: number | "me",
): Promise<Qualification>
Parameters
- context: string
- contextId: number
- id: number | "me"
Returns Promise<Qualification>
- Defined in d4h.ts:265

getMemberQualifications

getMemberQualifications(
    context: string,
    contextId: number,
    options?: GetQualificationOptions,
): Promise<Qualification[]>
Parameters
- context: string
- contextId: number
- Optionaloptions: GetQualificationOptions
Returns Promise<Qualification[]>
- Defined in d4h.ts:273

getMembers

getMembers(
    context: string,
    contextId: number,
    options?: GetMembersOptions,
): Promise<Member[]>
Parameters
- context: string
- contextId: number
- Optionaloptions: GetMembersOptions
Returns Promise<Member[]>
- Defined in d4h.ts:120

updateCustomFields

updateCustomFields(
    entity: Entity,
    updates: CustomFieldUpdate[],
    onlyMemberEditOwn: boolean,
): Promise<void>
Parameters
- entity: Entity
- updates: CustomFieldUpdate[]
- onlyMemberEditOwn: boolean
Returns Promise<void>
- Defined in d4h.ts:327

updateMember

updateMember(
    context: string,
    contextId: number,
    id: number,
    updates: MemberUpdate,
): Promise<void>
Parameters
- context: string
- contextId: number
- id: number
- updates: MemberUpdate
Returns Promise<void>
- Defined in d4h.ts:128