osapi.jive.corev3.places.Invite
An invitation to a place. For example, an invitation to join a private group.
Properties
Properties
Property | Type | Mode † | Description |
---|---|---|---|
body | String | read-only | ↑ The (HTML) body content of this invitation. |
email | String | read-only | ↑ The email address of the invitee, if not a Jive person. Otherwise,
the |
id | String | read-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. |
invitee | Person | read-only | ↑ The person that was invited, if the invitee is a Jive person. If not, the email field should be populated. |
inviter | Person | read-only | ↑ The person that issued this invitation. |
isFollowed | Boolean | read-only | ↑ Whether the current user is following this object. Availability:Will be present only for object types that support being followed. |
place | Place | read-only | ↑ The place to which the invitee was invited. |
published | ISO 8601 Date | read-only | ↑ The date and time at which this invite was created. |
resources | Object | read-only | ↑ Resource links (and related permissions for the requesting person) relevant to this object. |
revokeDate | ISO 8601 Date | read-only | ↑ The date and time at which this invitation was revoked (if any). |
revoker | Person | read-only | ↑ The person that revoked this invitation (if any). |
sentDate | ISO 8601 Date | read-only | ↑ The date and time at which this invitation was sent. |
state | String | read-only | ↑ The current state of this invitation. Valid values are:
|
type | String | read-only | ↑ The object type of this object ("invite") |
typeCode | Integer | read-only | ↑ |
updated | ISO 8601 Date | read-only | ↑ The date and time at which this invite was last updated. |
Methods
get(options)
GET /invites/1234
Retrieves
Invite
Description
Return an updated version of this invitation.
Options:
Name | Type | Required | Description |
---|---|---|---|
fields | String | false | Names of the fields to be returned |
Retrieves:
toURI()
Retrieves
String