@esri/solution-common
Version:
Provides general helper functions for @esri/solution.js.
59 lines (58 loc) • 5.46 kB
TypeScript
/** @license
* Copyright 2024 Esri
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Provides common functions and classes from ArcGIS REST JS.
*/
import { IFolderIdOptions, IGetGroupContentOptions, IGetUserOptions, IGroup, IGroupContentResult, IGetRelatedItemsResponse, IGroupSharingOptions, IItem, IItemRelationshipOptions, IItemResourceOptions, IItemResourceResponse, IPortal, IRemoveItemResourceOptions, ISearchOptions, ISearchResult, ISharingResponse, IUpdateGroupOptions, IUpdateItemOptions, IUpdateItemResponse, IUser, IUserGroupOptions, IUserItemOptions, SearchQueryBuilder } from "@esri/arcgis-rest-portal";
import { IRequestOptions } from "@esri/arcgis-rest-request";
import { IAddToServiceDefinitionOptions, IAddToServiceDefinitionResult, IQueryRelatedOptions, IQueryRelatedResponse } from "@esri/arcgis-rest-feature-service";
export { IAddToServiceDefinitionOptions, IAddToServiceDefinitionResult, ICreateServiceParams, ICreateServiceResult, IExtent, ISpatialReference, IFeature, IQueryRelatedOptions, IQueryRelatedResponse, IRelatedRecordGroup, createFeatureService as svcAdminCreateFeatureService, queryFeatures, addFeatures, applyEdits, } from "@esri/arcgis-rest-feature-service";
export { IAddFolderResponse, IAddItemDataOptions, ICreateItemOptions, ICreateItemResponse, IFolder, IFolderIdOptions, IGetGroupContentOptions, IGetRelatedItemsResponse, IGroup, IGroupAdd, IGroupCategorySchema as restIGroupCategorySchema, IItem, IItemRelationshipOptions, IItemResourceOptions, IItemResourceResponse, IManageItemRelationshipOptions, IMoveItemOptions, IMoveItemResponse, IPagedResponse, IPagingParams, IPortal, IRemoveItemResourceOptions, ISearchGroupContentOptions, ISearchOptions, ISearchResult, ISetAccessOptions, ISharingResponse, ItemRelationshipType, IUpdateGroupOptions, IUpdateItemOptions, IUpdateItemResponse, IUser, IUserContentResponse, IUserGroupOptions, IGroupSharingOptions, IUserItemOptions, addItemData as restAddItemData, addItemRelationship, createFolder, createGroup, createItem, createItemInFolder, moveItem, protectItem, SearchQueryBuilder, getGroupCategorySchema as restGetGroupCategorySchema, getItem, getItemData, getItemResources as restGetItemResources, getUserContent, getPortal as restGetPortal, getPortalUrl, searchGroupContent, setItemAccess, searchGroups as restSearchGroups, removeGroupUsers, removeItem as restRemoveItem, } from "@esri/arcgis-rest-portal";
export { IArcGISIdentityManagerOptions, ICredential, IRequestOptions, IParams, ArcGISAuthError, encodeFormData, ArcGISIdentityManager as UserSession, } from "@esri/arcgis-rest-request";
export interface IFolderSuccessResult {
success: boolean;
folder: {
username: string;
id: string;
title: string;
};
}
export interface IGroupSuccessResult {
success: boolean;
groupId: string;
}
export interface ISuccessResult {
success: boolean;
}
export declare function addItemResource(requestOptions: IItemResourceOptions): Promise<IItemResourceResponse>;
export declare function getGroup(id: string, requestOptions?: IRequestOptions): Promise<IGroup>;
export declare function getGroupContent(id: string, requestOptions?: IGetGroupContentOptions): Promise<IGroupContentResult>;
export declare function getRelatedItems(requestOptions: IItemRelationshipOptions): Promise<IGetRelatedItemsResponse>;
export declare function getSelf(requestOptions?: IRequestOptions): Promise<IPortal>;
export declare function queryRelated(requestOptions: IQueryRelatedOptions): Promise<IQueryRelatedResponse>;
export declare function removeItemResource(requestOptions: IRemoveItemResourceOptions): Promise<ISuccessResult>;
export declare function request(url: string, requestOptions?: IRequestOptions): Promise<any>;
export declare function restGetUser(requestOptions?: string | IGetUserOptions): Promise<IUser>;
export declare function restRemoveFolder(requestOptions: IFolderIdOptions): Promise<IFolderSuccessResult>;
export declare function restRemoveGroup(requestOptions: IUserGroupOptions): Promise<any>;
export declare function restSearchItems(search: string | ISearchOptions | SearchQueryBuilder): Promise<ISearchResult<IItem>>;
export declare function restUpdateGroup(requestOptions: IUpdateGroupOptions): Promise<IGroupSuccessResult>;
export declare function restUpdateItem(requestOptions: IUpdateItemOptions): Promise<IUpdateItemResponse>;
export declare function shareItemWithGroup(requestOptions: IGroupSharingOptions): Promise<ISharingResponse>;
export declare function svcAdminAddToServiceDefinition(url: string, requestOptions: IAddToServiceDefinitionOptions): Promise<IAddToServiceDefinitionResult>;
export declare function updateItemResource(requestOptions: IItemResourceOptions): Promise<IItemResourceResponse>;
export declare function unprotectGroup(requestOptions: IUserGroupOptions): Promise<ISuccessResult>;
export declare function unprotectItem(requestOptions: IUserItemOptions): Promise<ISuccessResult>;