static osapi.jive.corev3.members

Static class for getting and creating Jive social group Members. Creating a Member object results in adding a user to a group.

Methods

↑
create(member,options)
POST /members/places/{placeURI}

Retrieves

Member

Description

Create a new member, and return an entity describing it. The minimum information required to create a new member is:

     {
         "person" : "https://example.jiveon.com/api/core/v3/people/####",
         "state" : "member"
     }

The only valid states that may be used when creating a member are:

  • owner - Person has group administration capabilities as well as membership
  • member - Person has regular membership capabilities only
Takes:
  • Member Data describing the new membership
Options:
NameTypeRequiredDescription
placeURIStringtrueURI of the group for which to create a new member
fieldsStringfalseNames of the fields to be returned
Retrieves:
  • Member Representation of the newly created membership
    • ↑
    get(options)
    GET /members/{uri}

    Retrieves

    Member

    Description

    Return the specified membership by its URI.

    Options:
    NameTypeRequiredDescription
    uriStringtrueURI of the membership to be returned
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Member Representation of the requested membership
    • ↑
    getMembersByGroup(options)
    GET /members/places/{placeID}

    Retrieves

    Member[]

    Description

    Return the members of the group (by id).

    Options:
    NameTypeRequiredDescription
    uriStringfalseURI of the membership to be returned
    stateString[]falseList of states used to filter the returned results (default is all states). Possible values are: 'banned', 'invited', 'member', 'owner' and 'pending'.
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Member[] representing of the requested membership