PortalPublishSettings

Portal publish settings.

@example:
# publish an item on portal
itemId = ce.upload(uploadSettings)
publishSettings = PortalPublishSettings()
publishSettings.setItemId(itemId)
publishSettings.setName("test_PortalPublishSettings_4")
publishSettings.setAccess(PortalPublishSettings.ORGANIZATION)
publishSettings.setUrl(URL)
publishSettings.setUsername(username)
publishSettings.setPassword(password)
ce.publishPortalItem(publishSettings)

 

Methods defined here:

getAccess

getAccess(self):

Gets Access field. See the Portal REST API for a description of this property.

@return: Value of Access field.  ["PRIVATE", "SHARED", "ORGANIZATION", "PUBLIC"] [str]

getItemId

getItemId(self):

Gets ItemId field. The id of the item to be published.

@return: Value of ItemId field.  [str]

getName

getName(self):

Gets Name field. See the Portal REST API for a description of this property.

@return: Value of Name field.  [str]

getPassword

getPassword(self):

Gets Password field. The Portal password.

@return: Value of Password field.  [str]

getUrl

getUrl(self):

Gets Url field. The Portal url.

@return: Value of Url field.  [str]

getUsername

getUsername(self):

Gets Username field. The Portal username.

@return: Value of Username field.  [str]

setAccess

setAccess(self, enumValue):

Sets Access field. See the Portal REST API for a description of this property.

@param enumValue: the new value ["PRIVATE", "SHARED", "ORGANIZATION", "PUBLIC"]. [str]

setItemId

setItemId(self, stringValue):

Sets ItemId field. The id of the item to be published.

@param stringValue: the new value. [str]

setName

setName(self, stringValue):

Sets Name field. See the Portal REST API for a description of this property.

@param stringValue: the new value. [str]

setPassword

setPassword(self, stringValue):

Sets Password field. The Portal password.

@param stringValue: the new value. [str]

setUrl

setUrl(self, stringValue):

Sets Url field. The Portal url.

@param stringValue: the new value. [str]

setUsername

setUsername(self, stringValue):

Sets Username field. The Portal username.

@param stringValue: the new value. [str]

Constants

This class defines the following constants:

ORGANIZATION = 'ORGANIZATION'
PRIVATE = 'PRIVATE'
PUBLIC = 'PUBLIC'
SHARED = 'SHARED'