Enables one social network as a posting destination for an organisation and records how to post to it. There is at most one setting per organisation and provider id, and the posting credentials are not held here: they come from the signature credential of the linked profile that matches the same provider id. Provider specific options are held in the fields name value set.
Group: Database Entities
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| createdBy | Profile | The administrator who enabled this social network for the organisation. Never null. |
| createdDate | Date | When this social network was enabled for the organisation, as a timestamp. |
| fields | NvSet | Provider specific options for posting, held as a name value set and passed to the posting service as a map of string to string. Null when no options have been configured. |
| id | long | The database identifier of this social poster setting. |
| lastImportCompleted | Date | When an import from this social network last finished, as a timestamp. Null when no import has completed. |
| linkedTo | Profile | The profile whose social account is posted from. Posting looks up that profile's signature credentials and uses the one matching this provider id, so with no linked profile, or with no matching credential on it, nothing can be posted. |
| providerId | String | Identifies the social network this setting is for, such as the id of the registered posting service. Unique within the organisation and used both to find this setting and to pick the matching credential off the linked profile. |
Methods
getId() · setOrganisation(Organisation organisation) · getCreatedBy() · setCreatedBy(Profile createdBy) · getCreatedDate() · setCreatedDate(Date createdDate) · getLinkedTo() · setLinkedTo(Profile linkedTo) · getProviderId() · setProviderId(String providerId) · getFields() · setFields(NvSet fields) · getLastImportCompleted() · setLastImportCompleted(Date lastImportCompleted)
getId()
Returns: long
The database identifier of this social poster setting.
setOrganisation(Organisation organisation)
Returns: void
Sets the organisation this posting setting belongs to.
| Parameter | Description |
|---|---|
organisation | the owning organisation |
getCreatedBy()
Returns: Profile
The administrator who enabled this social network for the organisation. Never null.
setCreatedBy(Profile createdBy)
Returns: void
Sets the administrator who enabled this social network.
| Parameter | Description |
|---|---|
createdBy | the profile that created this setting |
getCreatedDate()
Returns: Date
When this social network was enabled for the organisation, as a timestamp.
setCreatedDate(Date createdDate)
Returns: void
Sets when this social network was enabled for the organisation.
| Parameter | Description |
|---|---|
createdDate | the date and time this setting was created |
getLinkedTo()
Returns: Profile
The profile whose social account is posted from. Posting looks up that profile's signature credentials and uses the one matching this provider id, so with no linked profile, or with no matching credential on it, nothing can be posted.
setLinkedTo(Profile linkedTo)
Returns: void
Sets the profile whose social account is posted from.
| Parameter | Description |
|---|---|
linkedTo | the profile supplying the posting credentials, or null to unlink |
getProviderId()
Returns: String
Identifies the social network this setting is for, such as the id of the registered posting service. Unique within the organisation and used both to find this setting and to pick the matching credential off the linked profile.
setProviderId(String providerId)
Returns: void
Sets the social network this setting is for.
| Parameter | Description |
|---|---|
providerId | the social provider's identifier |
getFields()
Returns: NvSet
Provider specific options for posting, held as a name value set and passed to the posting service as a map of string to string. Null when no options have been configured.
setFields(NvSet fields)
Returns: void
Sets the provider specific options for posting.
| Parameter | Description |
|---|---|
fields | the provider specific settings, or null for none |
getLastImportCompleted()
Returns: Date
When an import from this social network last finished, as a timestamp. Null when no import has completed.
setLastImportCompleted(Date lastImportCompleted)
Returns: void
Sets when an import from this social network last finished.
| Parameter | Description |
|---|---|
lastImportCompleted | the date and time the last import finished |