JavaScript API v3.2

osapi.jive.corev3.places.Invite

An invitation to a place. For example, an invitation to join a private group.

Properties

body
email
id
invitee
inviter
place
published
resources
revokeDate
revoker
sentDate
state
type
updated

Methods

destroy
get
toURI
update

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 `invitee` field will be populated.
`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.
`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: deleted - Marked for deletion but not yet removed by a background task. fulfilled - Conditions for fulfillment of this invitation have been met, but further action on the part of the invitee is required. processing - Initial state of an invitation after a user has been invited. State will automatically change to sent after it has been emailed. revoked - This invitation has been revoked and may no longer be accepted. sent - This invitation has been sent (via email), but not yet accepted.
`type`	`String`	read-only	↑ The object type of this object ("invite")
`updated`	`ISO 8601 Date`	read-only	↑ The date and time at which this invite was last updated.

Methods

destroy()
DELETE /invites/1234

Retrieves

--

Description

Remove this invitation.

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

Description

Retrieves:

A URI representing this entity, or undefined if no such URI exists.

update(options)
PUT /invites/1234

Retrieves

Invite

Description

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

Options:

Name	Type	Required	Description
fields	String	false	Names of the fields to be returned

Retrieves: