Skip to main content
Version: v1

OdspDocumentServiceFactoryCore Class

Factory for creating the sharepoint document service. Use this if you want to use the sharepoint implementation.

This constructor should be used by environments that support dynamic imports and that wish to leverage code splitting as a means to keep bundles as small as possible.

Signature​

export declare class OdspDocumentServiceFactoryCore implements IDocumentServiceFactory

Implements: IDocumentServiceFactory

Constructors​

Constructor Description
(constructor)(getStorageToken, getWebsocketToken, getSocketIOClient, persistedCache, hostPolicy) Constructs a new instance of the OdspDocumentServiceFactoryCore class

Properties​

Property Type Description
persistedCache IPersistedCache
protocolName

Methods​

Method Return Type Description
createContainer(createNewSummary, createNewResolvedUrl, logger, clientIsSummarizer) Promise<IDocumentService>
createDocumentService(resolvedUrl, logger, clientIsSummarizer) Promise<IDocumentService>
createDocumentServiceCore(resolvedUrl, odspLogger, cacheAndTrackerArg, clientIsSummarizer) Promise<IDocumentService>

Constructor Details​

(constructor)​

Constructs a new instance of the OdspDocumentServiceFactoryCore class

Signature​

constructor(getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>, getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined, getSocketIOClient: () => Promise<typeof SocketIOClientStatic>, persistedCache?: IPersistedCache, hostPolicy?: HostStoragePolicy);

Parameters​

Parameter Modifiers Type Description
getStorageToken TokenFetcher<OdspResourceTokenFetchOptions> function that can provide the storage token for a given site. This is is also referred to as the "Vroom" token in SPO.
getWebsocketToken TokenFetcher<OdspResourceTokenFetchOptions> | undefined function that can provide a token for accessing the web socket. This is also to as the "Push" token in SPO. If undefined then websocket token is expected to be returned with joinSession response payload.
getSocketIOClient () => Promise<typeof SocketIOClientStatic>
persistedCache optional IPersistedCache PersistedCache provided by host for use in this session.
hostPolicy optional HostStoragePolicy

Property Details​

persistedCache​

Signature​

protected persistedCache: IPersistedCache;

Type: IPersistedCache

protocolName​

Signature​

readonly protocolName = "fluid-odsp:";

Method Details​

createContainer​

Signature​

createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;

Parameters​

Parameter Modifiers Type Description
createNewSummary ISummaryTree | undefined
createNewResolvedUrl IResolvedUrl
logger optional ITelemetryBaseLogger
clientIsSummarizer optional boolean

Returns​

Return type: Promise<IDocumentService>

createDocumentService​

Signature​

createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;

Parameters​

Parameter Modifiers Type Description
resolvedUrl IResolvedUrl
logger optional ITelemetryBaseLogger
clientIsSummarizer optional boolean

Returns​

Return type: Promise<IDocumentService>

createDocumentServiceCore​

Signature​

protected createDocumentServiceCore(resolvedUrl: IResolvedUrl, odspLogger: TelemetryLogger, cacheAndTrackerArg?: ICacheAndTracker, clientIsSummarizer?: boolean): Promise<IDocumentService>;

Parameters​

Parameter Modifiers Type Description
resolvedUrl IResolvedUrl
odspLogger TelemetryLogger
cacheAndTrackerArg optional ICacheAndTracker
clientIsSummarizer optional boolean

Returns​

Return type: Promise<IDocumentService>