dojox/uuid/_base.js

• Provides:

  • dojox.uuid._base

• dojox.uuid.NIL_UUID

  • type

    String

• dojox.uuid.version

  • type

    Object

• dojox.uuid.version.UNKNOWN

  • type

    Number

• dojox.uuid.version.TIME_BASED

  • type

    Number

• dojox.uuid.version.DCE_SECURITY

  • type

    Number

• dojox.uuid.version.NAME_BASED_MD5

  • type

    Number

• dojox.uuid.version.RANDOM

  • type

    Number

• dojox.uuid.version.NAME_BASED_SHA1

  • type

    Number

• dojox.uuid.variant

  • alias - dojox.uuid.variant
  • type

    Object

• dojox.uuid.variant.NCS

  • type

    String

• dojox.uuid.variant.DCE

  • type

    String

• dojox.uuid.variant.MICROSOFT

  • type

    String

• dojox.uuid.variant.UNKNOWN

  • type

    String

• dojox.uuid.assert

  • parameters:
    • booleanValue: (typeof Boolean)

      Must be true for the assertion to succeed.

    • message: (typeof String)

      A string describing the assertion.
      throws: Throws an Error if 'booleanValue' is false.

  • summary

    Throws an exception if the assertion fails.

  • description

    If the asserted condition is true, this method does nothing. If the
    condition is false, we throw an error with a error message.

  • type

    Function

• dojox.uuid.generateNilUuid

  • returns

    String

  • summary

    This function returns the Nil UUID: "00000000-0000-0000-0000-000000000000".

  • description

    The Nil UUID is described in section 4.1.7 of
    RFC 4122: http://tools.ietf.org/html/rfc4122#section-4.1.7
    examples:
    var string = dojox.uuid.generateNilUuid();

  • type

    Function

• dojox.uuid.isValid

  • parameters:
    • uuidString: (typeof String)
  • returns

    boolean

  • summary

    Returns true if the UUID was initialized with a valid value.

  • type

    Function

• dojox.uuid.getVariant

  • parameters:
    • uuidString: (typeof String)
  • returns

    dojox.uuid.variant

  • summary

    Returns a variant code that indicates what type of UUID this is.
    Returns one of the enumerated dojox.uuid.variant values.

  • example

    var variant = dojox.uuid.getVariant("3b12f1df-5232-4804-897e-917bf397618a");
    dojox.uuid.assert(variant == dojox.uuid.variant.DCE);

  • example

    "3b12f1df-5232-4804-897e-917bf397618a"
    ^
    
    (variant "10__" == DCE)

  • type

    Function

• dojox.uuid._ourVariantLookupTable

  • alias - lookupTable

• dojox.uuid.getVersion

  • parameters:
    • uuidString: (typeof String)
  • returns

    dojox.uuid.version

  • summary

    Returns a version number that indicates what type of UUID this is.
    Returns one of the enumerated dojox.uuid.version values.

  • example

    var version = dojox.uuid.getVersion("b4308fb0-86cd-11da-a72b-0800200c9a66");
    dojox.uuid.assert(version == dojox.uuid.version.TIME_BASED);

  • exceptions

    Throws an Error if this is not a DCE Variant UUID.

  • type

    Function

• dojox.uuid.getNode

  • parameters:
    • uuidString: (typeof String)
  • returns

    String (a 12-character string, which will look something like "917bf397618a")

  • summary

    If this is a version 1 UUID (a time-based UUID), getNode() returns a
    12-character string with the "node" or "pseudonode" portion of the UUID,
    which is the rightmost 12 characters.

  • exceptions

    Throws an Error if this is not a version 1 UUID.

  • type

    Function

• dojox.uuid.getTimestamp

  • parameters:
    • uuidString: (typeof String)
    • returnType: (typeof String)

      Any of these five values: "string", String, "hex", "date", Date

  • returns

    String (e.g. "Mon, 16 Jan 2006 20:21:41 GMT")|String (e.g. "1da86cdb4308fb0")|Date

  • summary

    If this is a version 1 UUID (a time-based UUID), this method returns
    the timestamp value encoded in the UUID.  The caller can ask for the
    timestamp to be returned either as a JavaScript Date object or as a
    15-character string of hex digits.

  • return_summary

    Returns the timestamp value as a JavaScript Date object or a 15-character string of hex digits.
    examples:
    var uuidString = "b4308fb0-86cd-11da-a72b-0800200c9a66";
    var date, string, hexString;
    date   = dojox.uuid.getTimestamp(uuidString);         // returns a JavaScript Date
    date   = dojox.uuid.getTimestamp(uuidString, Date);     //
    string = dojox.uuid.getTimestamp(uuidString, String);   // "Mon, 16 Jan 2006 20:21:41 GMT"
    hexString = dojox.uuid.getTimestamp(uuidString, "hex"); // "1da86cdb4308fb0"

  • exceptions

    Throws an Error if this is not a version 1 UUID.

  • type

    Function

• dojox.uuid._base

  • type

    Object

• dojox.uuid

  • type

    Object

• dojox

  • type

    Object