Welcome to the Alfresco Builder Network

Our technical resource site is still being improved. We'd love to hear your feedback. Tell us what you think

Searches and gets information for groups.

Class members

Methods

  • checkGroupHasAnyClientAppRole(groupId: string, clientId: string, roleNames: string[]): Observable<boolean>
    Check if a group has any of the client app roles in the supplied list.
    • groupId: string - ID of the target group
    • clientId: string - ID of the client
    • roleNames: string[] - Array of role names to check
    • Returns Observable<boolean> - True if the group has one or more of the roles, false otherwise
  • checkGroupHasClientApp(groupId: string, clientId: string): Observable<boolean>
    Checks if a group has a client app.
    • groupId: string - ID of the target group
    • clientId: string - ID of the client
    • Returns Observable<boolean> - True if the group has the client app, false otherwise
  • checkGroupHasRole(groupId: string, roleNames: string[]): Observable<boolean>
    Check that a group has one or more roles from the supplied list.
    • groupId: string - ID of the target group
    • roleNames: string[] - Array of role names
    • Returns Observable<boolean> - True if the group has one or more of the roles, false otherwise
  • findGroupsByName(searchParams: GroupSearchParam): Observable<any>
    Finds groups filtered by name.
  • getClientIdByApplicationName(applicationName: string): Observable<string>
    Gets the client ID using the app name.
    • applicationName: string - Name of the app
    • Returns Observable<string> - client ID string
  • getClientRoles(groupId: string, clientId: string): Observable<any[]>
    Gets client roles.
    • groupId: string - ID of the target group
    • clientId: string - ID of the client
    • Returns Observable<any[]> - List of roles
  • getGroupDetailsById(groupId: string): any
    Gets details for a specified group.
    • groupId: string - ID of the target group
    • Returns any - Group details

Details

See the Groups API page in the Alfresco JS-API docs for further details about the information about the format of the returned data.

Interested in trying Alfresco?

Try Now