TXPushConfiguration

public final class TXPushConfiguration : NSObject

Class that holds the configuration of the pushTranslations() method that controls various aspect of the push to CDS.

  • Purge content

    If purge: true in meta object, then replace the entire resource content with the pushed content of this request.

    If purge: false in meta object (the default), then append the source content of this request to the existing resource content.

    Declaration

    Swift

    @objc
public let purge: Bool

  • Replace tags

    If overrideTags: true in meta object, then replace the existing string tags with the tags of this request.

    If overrideTags: false in meta object (the default), then append tags from source content to tags of existing strings instead of overwriting them.

    Declaration

    Swift

    @objc
public let overrideTags: Bool

  • Replace occurrences

    If overrideOccurrences: true in meta object, then replace the existing string occurrences with the occurrences of this request.

    If overrideOccurrences: false in meta object (the default), then append occurrences from source content to occurrences of existing strings instead of overwriting them.

    Declaration

    Swift

    @objc
public let overrideOccurrences: Bool

  • Keep translations

    If keepTranslations: true in meta object (the default), then preserve translations on source content updates.

    If keepTranslations: false in meta object, then delete translations on source string content updates.

    Declaration

    Swift

    @objc
public let keepTranslations: Bool

  • Dry run

    If dryRun: true in meta object, then emulate a content push, without doing actual changes.

    Declaration

    Swift

    @objc
public let dryRun: Bool

  • Initialize the push configuration object with the provided parameters.

    Refer to the documentation of each property for default values and more information.

    Declaration

    Swift

    @objc
public init(purge: Bool = false,
            overrideTags: Bool = false,
            overrideOccurrences: Bool = false,
            keepTranslations: Bool = true,
            dryRun: Bool = false)

    Parameters

    purge

    The purge content boolean flag.
    overrideTags

    The override tags boolean flag.
    overrideOccurrences

    The override occurrences boolean flag.
    keepTranslations

    The keep translations boolean flag.
    dryRun

    The dry run boolean flag.

  • Description of the configuration used for debugging purposes

    Declaration

    Swift

    public override var debugDescription: String { get }