inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-ng2-components/docs/process-services-cloud/services/group-cloud.service.md
Eugenio Romano c3452a4f62
Documentation build (#6762) 
* move doc dependency in doctools

* add ignore link

* rebuild doc

* version index

* put it back some deps
2021-03-03 14:08:15 +00:00

3.8 KiB
Raw Permalink Blame History

Title, Added, Status, Last reviewed
Title Added Status Last reviewed
Group Cloud Service v3.0.0 Experimental 2019-02-06

Group Cloud Service

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
  • getGroupRoles(groupId: string): Observable<GroupRoleModel[]>
    Gets details for a specified group.

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.