osapi.jive.corev3.places.Member

A social group member. Represents one Person's membership to one Group.

Example:
Example JSON

JSON with the most important data for a Member. See the table below for a list of all fields.

{
  "type" : "member",
  "state" : "owner",
  "group" : {
    "type" : "group",
    "memberCount" : 1,
    "creator" : {
      "name" : {
        "formatted" : "Administrator"
      },
      "type" : "person",
      "displayName" : "Administrator",
      "id" : "1"
    },
    "groupType" : "PRIVATE",
    "name" : "Group created on Fri Jul 20 2012 15:46:56 GMT-0700 (Pacific Daylight Time) using v3 API 135109",
    "displayName" : "group1342824416138842803",
    "status" : "Active",
    "contentTypes" : [ "blog", "documents", "files", "discussions", "polls", "projects" ],
    "viewCount" : 0,
    "published" : "2012-07-20T22:42:20.234+0000",
    "updated" : "2012-07-20T22:42:20.234+0000",
    "visibleToExternalContributors" : false,
    "tags" : [ ],
    "followerCount" : 1
  },
  "person" : {
      // Person JSON appears here
  }
}

Properties

PropertyTypeMode Description
groupGroupread-only

Group to which this member belongs.

idStringread-only

Identifier (unique within an object type and Jive instance) of this object. This field is internal to Jive and should not be confused with contentID or placeID used in URIs.

personPersonread-only

Jive person that is a member of the specified group.

publishedISO 8601 Dateread-only

Date and time this object was originally created.

resourcesObjectread-only

Resource links (and related permissions for the requesting person) relevant to this object.

stateStringrequired

Current state of this membership. Valid values are:

  • banned - Previously accepted member has been banned from further involvement.
  • invited - Person has been invited but has not yet accepted the invitation.
  • member - Current member with standard permissions.
  • owner - Current member with place owner permissions.
  • pending - Person has requested membership but has not yet been accepted.
typeStringread-only

The object type of this object ("member").

updatedISO 8601 Dateread-only

Date and time this object was most recently updated.

→ Fields used by update and create operations
→ Fields used only by create operations
→ Fields not used by update or create operations

Methods

destroy()
DELETE /members/1234

Retrieves

--

Description

Remove this membership in the specified group.

get(options)
GET /members/1234

Retrieves

Member

Description

Return an updated version of this membership.

Options:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned
Retrieves:
  • Member
  • toURI()

    Retrieves

    String

    Description

    Retrieves:
  • A URI representing this entity, or undefined if no such URI exists.
  • update(options)
    PUT /members/1234

    Retrieves

    Member

    Description

    Update the information for this membership, and return an updated representation of it.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Member