Class WSKBrowseSourcesRequest

Description

This class encloses the necessary elements to perform an BrowseSources operation

  • example: example not found

Located in /wsk/WSKBrowseSourcesRequest.class.php (line 6)


	
			
Variable Summary
Method Summary
WSKBrowseSourcesRequest __construct (string $binarySecurityToken, string $locale, [string $folderId = null])
Variables
string $binarySecurityToken (line 12)

This authentication token must be included in all non-authentication types of requests.

  • access: public
int $folderId (line 31)

Identifies the folder within the source directory from which navigation will begin. If this element is empty, navigation will begin at the top of the source directory.

Note: The folder IDs provided in the response message can be used in subsequent BrowseSources requests to begin navigation from a specific point within the directory structure.

  • access: public
string $locale (line 24)

Identifies the language associated with the request.

  • see: userInformation::lFr
  • see: userInformation::lDe
  • see: userInformation::lEnUS
  • see: userInformation::lEnNZ
  • see: userInformation::lEnAU
  • see: userInformation::lEnGB
  • access: public
Methods
Constructor __construct (line 38)
  • access: public
WSKBrowseSourcesRequest __construct (string $binarySecurityToken, string $locale, [string $folderId = null])
  • string $binarySecurityToken: This authentication token must be included in all non-authentication types of requests.
  • string $locale: Identifies the language associated with the request.
  • string $folderId: Identifies the folder within the source directory from which navigation will begin. If this element is empty, navigation will begin at the top of the source directory.

Documentation generated on Thu, 10 Dec 2009 15:22:25 +0100 by phpDocumentor 1.4.1