Class SegmentSuggestions

Methods for dealing with SegmentSuggestions.

Index

Methods

getAll getById reject

Methods

getAll

getAll(): SegmentSuggestion[]
Returns SegmentSuggestion[]
an array of all the segment suggestions in the WME data model

getById

getById(args: { segmentSuggestionId: number }): null | SegmentSuggestion
Parameters
- args: { segmentSuggestionId: number }
  - segmentSuggestionId: number
    An id of the segment suggestion to find.
Returns null | SegmentSuggestion
segment suggestion with id, or null if not found in the WME data model

reject

reject(
    args: {
        reason: SegmentSuggestionRejectionReason;
        segmentSuggestionIds: number[];
    },
): void
Rejects segment suggestions with the specified reason.
Parameters
- args: { reason: SegmentSuggestionRejectionReason; segmentSuggestionIds: number[] }
  - reason: SegmentSuggestionRejectionReason
    Rejection reason for segment suggestion.
  - segmentSuggestionIds: number[]
    Array of IDs of segment suggestions to reject.
Returns void
Throws
DataModelNotFoundError if any segment suggestion with the specified ID is not found in the data model.

Throws
InvalidStateError if no IDs are provided or if failed to reject the segment suggestions.