Campaign Manager API

LockCampaign

This method locks or unlocks a campaign. The method returns void. Its signature is:

void LockCampaign(
   string nodeName,
   string campaignID,
   LockAction editLockAction,
   UserInfo userInfo
);

Method Parameters

Parameters for this method are shown in the following table.

Parameter

Description

Type

Valid Input

nodeName

The DeltaV node where the Campaign Manager server is located

String

Name of node 

campaignID

Name of the campaign

String

Campaign node

editLockAction

Locks or unlocks the specified campaign

LockAction

Lock

Unlock

userInfo

Credentials of the user. Can be null if not required

UserInfo

UserInfo instance or null