Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "crud/membership"

Index

Functions

Const addOrganizationToMembership

  • Add organization details to membership

    Parameters

    Returns Promise<Membership>

Const addOrganizationToMemberships

  • Add organization details to memberships

    Parameters

    Returns Promise<Membership[]>

Const createMembership

  • createMembership(membership: Membership): Promise<Object>
  • Parameters

    Returns Promise<Object>

Const deleteAllOrganizationMemberships

  • deleteAllOrganizationMemberships(organizationId: number): Promise<Object>
  • Parameters

    • organizationId: number

    Returns Promise<Object>

Const deleteAllUserMemberships

  • deleteAllUserMemberships(userId: number): Promise<Object>
  • Parameters

    • userId: number

    Returns Promise<Object>

Const deleteMembership

  • deleteMembership(id: number): Promise<Object>
  • Parameters

    • id: number

    Returns Promise<Object>

Const getMembership

  • Parameters

    • id: number

    Returns Promise<Membership>

Const getMembershipDetailed

  • getMembershipDetailed(id: number): Promise<any>
  • Parameters

    • id: number

    Returns Promise<any>

Const getOrganizationMemberDetails

  • getOrganizationMemberDetails(organizationId: number, query?: KeyValue): Promise<any>
  • Parameters

    • organizationId: number
    • Optional query: KeyValue

    Returns Promise<any>

Const getOrganizationMembers

  • getOrganizationMembers(organizationId: number): Promise<Membership[]>
  • Parameters

    • organizationId: number

    Returns Promise<Membership[]>

Const getUserMemberships

  • Parameters

    • user: User | number

    Returns Promise<Membership[]>

Const getUserMembershipsDetailed

  • getUserMembershipsDetailed(user: User | number): Promise<any>
  • Get a detailed object of a user's membership

    Parameters

    • user: User | number

    Returns Promise<any>

Const getUserOrganizationMembership

  • Get a user membership of a particular organization

    Parameters

    Returns Promise<Membership>

Const updateMembership

  • updateMembership(id: number, membership: KeyValue): Promise<Object>
  • Parameters

    Returns Promise<Object>

Generated using TypeDoc