Class ConfirmAndUpdateOptions

Encapsulates options for confirm and update rows on server project translation documents.

Inheritance
Object
ConfirmAndUpdateOptions
Syntax
public class ConfirmAndUpdateOptions
Remarks

Based on the value of the UserNameBehavior field there are two different ways to confirm and update the segments of a document:

  1. The value of the UserNameBehavior is UseProjectDefault: in this case the server will use the name of the user, who performs the confirm and update operation, as creator/modifier when updating the translation memories, and updateing the statuses of the document segments. You can specify this user with the other parameters of the confirm and update WS-API functions. If you use the ConfrimAndUpdate function, you have to provide the sessionId belonging to the user who performs the confirm and update. If you use the ConfirmAndUpdate2 function, you have to provide the guid of the user who performs the confirm and update operation.
  2. The value of the UserNameBehavior is UseNameStoredWithRow: in this case the server uses the user names stored with the document rows, when updating the translation memories during the confirm and update process. You should use the DocumentRoleToUse field, to specify from which role would you like to use the user name. If there is no stored user name in this role for the document, the server will use the value of the DefaultUserName field.

Fields

CustomMetas

The custom meta definitions and values as multi-line string. Null and as well as an empty string both mean "no custom metas". Each line has three or more columns, separated by tabs: metaName metaType value [value2...valueN] Possible metaType values: FreeText Number DateTime PickListSingle PickListMultiple

Declaration
public string CustomMetas
Type
String

DefaultUserName

memoQ will use this default user name during the update of the translation memories if the user name for the selected document assignment role (see DocumentRoleToUse) is not defined.

Declaration
public string DefaultUserName
Type
String
Remarks

The server will use this field only when the UserNameBehavior is UseNameStoredWithRow.

DocumentRoleToUse

If UserNameBehavior is UseNameStoredWithRowuser then you can specify which document assignment role to use to determine the user name during the update of the translation memories. The currently accepted values are the following: 0: Translator 1: Reviewer1 2: Reviewer2

Declaration
public byte DocumentRoleToUse
Type
Byte
Remarks

The server will use this field only when the UserNameBehavior is UseNameStoredWithRow.

MakeRowsProofread

Indicates whether make rows proofread or only confirmed. It does not modify the status of the segment if the segment's status is already proofread and the parameter value is false.

Declaration
public bool MakeRowsProofread
Type
Boolean
Remarks

OBSOLETE - FROM SERVER VERSION 7.5 USE RoleForConfirmation PROPERTY TO SET THE DOCUMENT ASSIGNMENT ROLE TO CONFIRM SEGMENTS. If UseRoleForConfirmation is true the specified role will be used, else the one defined by this property.

RoleForConfirmation

If UseRoleForConfirmation is true then you can specify which document assignment role to use to confirm segments. The currently accepted values are the following: 0: Translator 1: Reviewer1 2: Reviewer2 3: Unchanged - Translation state wont be changed

Declaration
public byte RoleForConfirmation
Type
Byte
Remarks

The server will use this field only when the UseRoleForConfirmation is true

Status

The statuses of segments to confirm. The segments with other statuses will be skipped during the confirm and update operation.

Declaration
public ConfirmAndUpdateSegmentStatuses Status
Type
ConfirmAndUpdateSegmentStatuses

UpdateTMBehavior

Which TM to update during confirm and update operation;

Declaration
public ConfirmAndUpdateTMBehaviors UpdateTMBehavior
Type
ConfirmAndUpdateTMBehaviors

UpdateTMRepository

Also update the TM repository during confirm and update operation.

Declaration
public bool UpdateTMRepository
Type
Boolean

UserNameBehavior

The use name behavior to use during the confirm and update process.

Declaration
public ConfirmAndUpdateUserNameBehaviors UserNameBehavior
Type
ConfirmAndUpdateUserNameBehaviors

UseRoleForConfirmation

Indicates whether use the given role for confirmation. If the parameter value is false the given confirmation role will not be observed, then it will be defined by MakeRowsProofread property.

Declaration
public bool UseRoleForConfirmation
Type
Boolean