Class WMAssetIdentifier
Contains all of the logic necessary to identify, parse, and organize asset identifiers. Given the increasing complexity of identifiers (i.e. IDs, FullPathNames, and now versions), it is necessary to reduce duplicated code. This class will stand in for a string anywhere a directory or ID is used other than as properties in assets, and in GET functions for assets.
Inherited Members
Namespace: Quantellia.WMServer.Asset.Model
Assembly: WMServer.dll
Syntax
public class WMAssetIdentifierProperties
DBIdentifier
An HTML decoded and normalized identifier for use in Database queries starting with //...
Declaration
public string DBIdentifier { get; }Property Value
| Type | Description |
|---|---|
| string |
Identifier
An HTML decoded and normalized identifier for use in the WMServer application starting with /... This identifier can be a FullPath or ID, but does not have a version.
Declaration
public string Identifier { get; }Property Value
| Type | Description |
|---|---|
| string |
IsRootDirectory
Returns whether this identifier matches the Root directory. Note that each asset table has individual IDs, so this property is only correct in the context of a WMAssetDirectory's identifier.
Declaration
public bool IsRootDirectory { get; }Property Value
| Type | Description |
|---|---|
| bool |
Version
The specific version this identifier specifies, if any.
Declaration
public int Version { get; }Property Value
| Type | Description |
|---|---|
| int |
VersionString
A string representing the version of this asset. Can return macros.
Declaration
public string VersionString { get; }Property Value
| Type | Description |
|---|---|
| string |
VersionType
The type of version this identifier specifies.
Declaration
public WMAssetIdentifier.VersionTypes VersionType { get; }Property Value
| Type | Description |
|---|---|
| WMAssetIdentifier.VersionTypes |
Methods
Parse(string?)
HTML decodes, normalizes, and parses an identifier, whether an ID or FullPathName, with or without a version.
Declaration
public static WMAssetIdentifier Parse(string? fullIdentifier)Parameters
| Type | Name | Description |
|---|---|---|
| string | fullIdentifier | A string representing the asset, can be HTML endoded, be an internal or external FullPathName representation or ID, and can have an optional version or macro. |
Returns
| Type | Description |
|---|---|
| WMAssetIdentifier |
Parse(string, int)
HTML decodes, normalizes, and parses an identifier, whether an ID or FullPathName, with the provided version. Even if the provided identifier string contains a version, it will be replaced with the provided version.
Declaration
public static WMAssetIdentifier Parse(string identifier, int version)Parameters
| Type | Name | Description |
|---|---|---|
| string | identifier | A string representing the asset, can be HTML endoded, be an internal or external FullPathName representation or ID. |
| int | version | The integer version of the asset. Can be 0 to specify the Head |
Returns
| Type | Description |
|---|---|
| WMAssetIdentifier |
Parse(string, string)
HTML decodes, normalizes, and parses an identifier, whether an ID or FullPathName, with the provided version. Even if the provided identifier string contains a version, it will be replaced with the provided version.
Declaration
public static WMAssetIdentifier Parse(string identifier, string version)Parameters
| Type | Name | Description |
|---|---|---|
| string | identifier | A string representing the asset, can be HTML endoded, be an internal or external FullPathName representation or ID. |
| string | version | The version of this asset. Can be a macro or specific version |
Returns
| Type | Description |
|---|---|
| WMAssetIdentifier |
ToString()
Converts an Identifier to its string representation "/A/B/C/D", "/A/B/C/D;Head", etc...
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| string |