IWorkspaceLocalizationService
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Reads how languages and translations are used in one workspace.
export interface IWorkspaceLocalizationService
Remarks
Usage covers the workspace alone. Statistics cover the workspace and its ancestors.
Methods
Method | Description |
|---|---|
(ALPHA) List the languages with translations in the workspace and its ancestors. | |
(ALPHA) List translation coverage of the workspace and its ancestors. | |
(ALPHA) Count the workspace and the people with access to it that miss a translation, or do not use an available one. | |
(ALPHA) Summarize language usage in the workspace and among the people with access to it. | |
(ALPHA) List the people behind a usage count, sorted by name. | |
(ALPHA) List the workspaces behind a usage count, sorted by name. |
Method details
IWorkspaceLocalizationService.getStatistics()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
List the languages with translations in the workspace and its ancestors.
getStatistics(): Promise<ILocalizationStatistics>;
Returns
Promise<ILocalizationStatistics>
IWorkspaceLocalizationService.getStatisticsWorkspaces()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
List translation coverage of the workspace and its ancestors.
getStatisticsWorkspaces(query?: ILocalizationPageQuery): Promise<ILocalizationStatisticsWorkspacesPage>;
Parameters
Parameter | Type | Description |
|---|---|---|
query | (Optional) |
Returns
IWorkspaceLocalizationService.getTranslationUsage()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Count the workspace and the people with access to it that miss a translation, or do not use an available one.
getTranslationUsage(): Promise<ILocalizationTranslationUsage>;
Returns
Promise<ILocalizationTranslationUsage>
IWorkspaceLocalizationService.getUsage()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Summarize language usage in the workspace and among the people with access to it.
getUsage(): Promise<ILocalizationUsage>;
Returns
Promise<ILocalizationUsage>
IWorkspaceLocalizationService.getUsageUsers()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
List the people behind a usage count, sorted by name.
getUsageUsers(query?: ILocalizationUsageListQuery): Promise<ILocalizationUsageUsersPage>;
Parameters
Parameter | Type | Description |
|---|---|---|
query | (Optional) |
Returns
Promise<ILocalizationUsageUsersPage>
IWorkspaceLocalizationService.getUsageWorkspaces()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
List the workspaces behind a usage count, sorted by name.
getUsageWorkspaces(query?: ILocalizationUsageListQuery): Promise<ILocalizationUsageWorkspacesPage>;
Parameters
Parameter | Type | Description |
|---|---|---|
query | (Optional) |
Returns
Promise<ILocalizationUsageWorkspacesPage>