Apex Reference Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
CdpActivation Class
Namespace
CdpActivation Methods
getActivations()
API Version
60.0
Requires Chatter
No
Signature
public static ConnectApi.ActivationCollection getActivations()
Return Value
getActivationsPaginated(batchSize, offset, orderBy, filters)
API Version
60.0
Requires Chatter
No
Signature
public static ConnectApi.ActivationCollection getActivationsPaginated(Integer batchSize, Integer offset, String orderBy, String filters)
Parameters
- batchSize
- Type: Integer
- Number of results to return. Values are from 1 through 200. If unspecified, the default value is 20.
- offset
- Type: Integer
- Number of rows to skip before returning results. Must be greater than or equal to 0. If unspecified, no rows are skipped.
- orderBy
- Type: String
- Specify createdDate to sort results by creation date. If unspecified, items are returned by ID in ascending order.
- filters
- Type: String
- Filter the result set to a more narrow scope or specific type. These filters are
supported:
- name (field name: name; description: name of the activation)
- marketSegmentId (field name: segmentId; description: segment ID of the activation)
- activationTargetId (field name: activationTarget.id; description: activation target ID of the activation)
- activationRefreshType (field name: refreshType; description: refresh type of the activation; example: incremental)
- activationStatus (field name: status; description: status of the activation, which accepts only the values in the status response field; example: active)
Return Value
createActivation(input)
API Version
60.0
Requires Chatter
No
Signature
public static ConnectApi.Activation createActivation(ConnectApi.ActivationDefinitionInput input)
Parameters
- input
- Type: ConnectApi.ActivationDefinitionInput
- Input representation for an activation.
Return Value
Type: ConnectApi.Activation
deleteActivation(activationId)
API Version
60.0
Requires Chatter
No
Signature
public static Void deleteActivation(String activationId)
Parameters
- activationId
- Type: String
- The unique identifier (ID) or developer name of a specific activation target.
Return Value
Type: Void
getActivation(activationId)
API Version
60.0
Requires Chatter
No
Signature
public static ConnectApi.Activation getActivation(String activationId)
Parameters
- activationId
- Type: String
- The unique identifier (ID) or developer name of a specific activation target.
Return Value
Type: ConnectApi.Activation
updateActivation(activationId, input)
API Version
60.0
Requires Chatter
No
Signature
public static ConnectApi.Activation updateActivation(String activationId, ConnectApi.ActivationDefinitionInput input)
Parameters
- activationId
- Type: String
- The unique identifier (ID) or developer name of a specific activation target.
- input
- Type: ConnectApi.ActivationDefinitionInput
- Input representation for an activation.
Return Value
Type: ConnectApi.Activation