office-addin-usage-data
Version:
Provides infrastructure to send usage data events and exceptions.
90 lines (89 loc) • 4.19 kB
TypeScript
/**
* Specifies the usage data infrastructure the user wishes to use
* @enum Application Insights: Microsoft Azure service used to collect and query through data
* @deprecated Usage data reporting has been removed
*/
export declare enum UsageDataReportingMethod {
applicationInsights = "applicationInsights"
}
/**
* Level controlling what type of usage data is being sent
* @enum off: off level of usage data, sends no usage data
* @enum on: on level of usage data, sends errors and events
* @deprecated Usage data reporting has been removed
*/
export declare enum UsageDataLevel {
off = "off",
on = "on"
}
/**
* Defines an error that is expected to happen given some situation
* @member message Message to be logged in the error
*/
export declare class ExpectedError extends Error {
constructor(message: string | undefined);
}
/**
* UpdateData options
* @deprecated Usage data reporting has been removed
*/
export interface IUsageDataOptions {
groupName?: string;
projectName: string;
connectionString?: string;
instrumentationKey?: string;
promptQuestion?: string;
raisePrompt?: boolean;
usageDataLevel?: UsageDataLevel;
method?: UsageDataReportingMethod;
isForTesting?: boolean;
deviceID?: string;
}
/**
* Usage data class - all methods are now no-ops since telemetry has been removed
* @deprecated Usage data reporting has been removed. This class is retained for API compatibility only.
*/
export declare class OfficeAddinUsageData {
private options;
constructor(usageDataOptions: IUsageDataOptions);
/** @deprecated No-op - usage data reporting has been removed */
reportEvent(_eventName: string, _data: object): Promise<void>;
/** @deprecated No-op - usage data reporting has been removed */
reportEventApplicationInsights(_eventName: string, _data: object): Promise<void>;
/** @deprecated No-op - usage data reporting has been removed */
reportError(_errorName: string, _err: Error): Promise<void>;
/** @deprecated No-op - usage data reporting has been removed */
reportErrorApplicationInsights(_errorName: string, _err: Error): Promise<void>;
/** @deprecated No-op - usage data reporting has been removed */
usageDataOptIn(_testData?: boolean, _testResponse?: string): void;
/** @deprecated No-op - usage data reporting has been removed */
setUsageDataOff(): void;
/** @deprecated No-op - usage data reporting has been removed */
setUsageDataOn(): void;
/** @deprecated Always returns false - usage data reporting has been removed */
isUsageDataOn(): boolean;
/** @deprecated Returns empty string - usage data reporting has been removed */
getUsageDataKey(): string;
/** @deprecated Always returns 0 - usage data reporting has been removed */
getEventsSent(): number;
/** @deprecated Always returns 0 - usage data reporting has been removed */
getExceptionsSent(): number;
/** @deprecated Always returns "off" - usage data reporting has been removed */
getUsageDataLevel(): string;
/** @deprecated Returns error unchanged - usage data reporting has been removed */
maskFilePaths(err: Error): Error;
/** @deprecated No-op - usage data reporting has been removed */
reportException(_method: string, _err: Error | string, _data?: object): void;
/** @deprecated No-op - usage data reporting has been removed */
reportExpectedException(_method: string, _err: Error | string, _data?: object): void;
/** @deprecated No-op - usage data reporting has been removed */
reportSuccess(_method: string, _data?: object): void;
/** @deprecated No-op - usage data reporting has been removed */
sendUsageDataException(_method: string, _err: Error | string, _data?: object): void;
/** @deprecated No-op - usage data reporting has been removed */
sendUsageDataSuccessEvent(_method: string, _data?: object): void;
/** @deprecated No-op - usage data reporting has been removed */
sendUsageDataSuccessfulFailEvent(_method: string, _data?: object): void;
/** @deprecated No-op - usage data reporting has been removed */
sendUsageDataEvent(_data?: object): void;
}