@microsoft/teams-js
Version:
Microsoft Client SDK for building app for Microsoft hosts
39 lines (38 loc) • 1.32 kB
TypeScript
import { ISerializable } from './serializable.interface';
/**
* @internal
* Limited to Microsoft-internal use
*
* Represents a UUID (Universally Unique Identifier) object.
* This class provides a way to generate, validate, and represent UUIDs as strings.
*/
export declare class UUID implements ISerializable {
private readonly uuid;
/**
* Creates an instance of the UUID class.
* If no UUID string is provided, a new UUID is generated.
*
* @param {string} [uuid=generateGUID()] - The UUID string. Defaults to a newly generated UUID.
* @throws {Error} - Throws an error if the provided UUID is invalid.
*/
constructor(uuid?: string);
/**
* Returns the UUID as a string.
*
* @returns {string} - The UUID string.
*/
toString(): string;
/**
* @returns A serializable representation of an uuid, used for passing uuids to the host.
*/
serialize(): object | string;
}
/**
* @hidden
* Checks if the incoming id is an instance of ValidatedSafeString
* @param id An object to check if it's an instance of ValidatedSafeString
* @throws Error with a message describing the violation
* @internal
* Limited to Microsoft-internal use
*/
export declare function validateUuidInstance(id: UUID): void;