Detailed Description
Encloses a collection of elements which provide detailed information about a single source in the requested folder.
- See also:
- WSKGetSourceDetailsResponse
Constructor & Destructor Documentation
__construct |
( |
$ |
sourceId = null , |
|
|
$ |
name = null , |
|
|
$ |
type = null , |
|
|
$ |
premiumSource = null , |
|
|
$ |
hasIndex = null , |
|
|
$ |
hasTOC = null , |
|
|
$ |
versionable = null , |
|
|
$ |
isPageBrowsable = null , |
|
|
$ |
combinabilityList = null |
|
) |
| |
Cosntructs a source object
- Parameters:
-
int | $sourceId | Contains a unique identifier value used to represent a specific source in the source directory. |
string | $name | Contains either the actual name of the publication or the name given to a group of publications. |
string | $type | The SecuredSource flag indicates that this source has secured source information that should or must be displayed to your user before they are permitted to access this source. The GetSourceDetails operation is used to retrieve this secured source information. |
boolean | $premiumSource | true indicates that this source is outside your user's subscription and is only available at an additional charge. |
boolean | $hasIndex | true indicates that this source has an index source associated with it. |
boolean | $hasTOC | true indicates that this source has a table of contents source associated with it. |
boolean | $versionable | true indicates that some documents within this source may have multiple versions available. This can be used to determine when offer the ability to retrieve different document versions. |
boolean | $isPageBrowsable | true indicates that the source page can be browsed. |
| WSKCombinabilityList | Contains the list of combinability strings for this source. |
Field Documentation
The documentation for this class was generated from the following file: