Package com.alfresco.content.apis

Interface NetworksApi

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract PersonNetworkEntry getNetwork(@Path(value = "networkId") String networkId, @Query(value = "fields") List<String> fields) Get a network Gets information for a network networkId.
      abstract PersonNetworkEntry getNetworkForPerson(@Path(value = "personId") String personId, @Path(value = "networkId") String networkId, @Query(value = "fields") List<String> fields) Get network information Gets network information on a single network specified by networkId for personId.
      abstract PersonNetworkPaging listNetworksForPerson(@Path(value = "personId") String personId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "fields") List<String> fields) List network membership Gets a list of network memberships for person personId.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • getNetwork

        @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/networks/{networkId}") abstract PersonNetworkEntry getNetwork(@Path(value = "networkId") String networkId, @Query(value = "fields") List<String> fields)

        Get a network Gets information for a network networkId. The endpoint is owned by defaultname service owner

        Parameters:
        networkId - The identifier of a network.
        fields - A list of field names.

      • getNetworkForPerson

        @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/people/{personId}/networks/{networkId}") abstract PersonNetworkEntry getNetworkForPerson(@Path(value = "personId") String personId, @Path(value = "networkId") String networkId, @Query(value = "fields") List<String> fields)

        Get network information Gets network information on a single network specified by networkId for personId. You can use the -me- string in place of <personId> to specify the currently authenticated user. The endpoint is owned by defaultname service owner

        Parameters:
        personId - The identifier of a person.
        networkId - The identifier of a network.
        fields - A list of field names.

      • listNetworksForPerson

        @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/people/{personId}/networks") abstract PersonNetworkPaging listNetworksForPerson(@Path(value = "personId") String personId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "fields") List<String> fields)

        List network membership Gets a list of network memberships for person personId. You can use the -me- string in place of <personId> to specify the currently authenticated user. The endpoint is owned by defaultname service owner

        Parameters:
        personId - The identifier of a person.
        skipCount - The number of entities that exist in the collection before those included in this list.
        maxItems - The maximum number of items to return in the list.
        fields - A list of field names.