// (C) Copyright 2015 Moodle Pty Ltd.
//
// 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.
import { Injectable } from '@angular/core';
import { TranslateService } from '@ngx-translate/core';
import { CoreEventsProvider } from '@providers/events';
import { CoreLoggerProvider } from '@providers/logger';
import { CoreSitesProvider, CoreSitesCommonWSOptions, CoreSitesReadingStrategy } from '@providers/sites';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreAppProvider } from '@providers/app';
import { CoreFilepoolProvider } from '@providers/filepool';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
import { AddonModWikiOfflineProvider } from './wiki-offline';
import { CoreSite } from '@classes/site';
import { CoreCourseCommonModWSOptions } from '@core/course/providers/course';
export interface AddonModWikiSubwikiListData {
/**
* Number of subwikis.
*/
count: number;
/**
* Subwiki ID currently selected.
*/
subwikiSelected: number;
/**
* User of the subwiki currently selected.
*/
userSelected: number;
/**
* Group of the subwiki currently selected.
*/
groupSelected: number;
/**
* List of subwikis.
*/
subwikis: any[];
}
/**
* Service that provides some features for wikis.
*/
@Injectable()
export class AddonModWikiProvider {
static COMPONENT = 'mmaModWiki';
static PAGE_CREATED_EVENT = 'addon_mod_wiki_page_created';
static RENEW_LOCK_TIME = 30000; // Milliseconds.
protected ROOT_CACHE_KEY = 'mmaModWiki:';
protected logger;
protected subwikiListsCache: {[wikiId: number]: AddonModWikiSubwikiListData} = {};
constructor(logger: CoreLoggerProvider, private sitesProvider: CoreSitesProvider, private appProvider: CoreAppProvider,
private filepoolProvider: CoreFilepoolProvider, private utils: CoreUtilsProvider, private translate: TranslateService,
private wikiOffline: AddonModWikiOfflineProvider, eventsProvider: CoreEventsProvider,
private logHelper: CoreCourseLogHelperProvider) {
this.logger = logger.getInstance('AddonModWikiProvider');
// Clear subwiki lists cache on logout.
eventsProvider.on(CoreEventsProvider.LOGIN, () => {
this.clearSubwikiList();
});
}
/**
* Clear subwiki list cache for a certain wiki or all of them.
*
* @param wikiId wiki Id, if not provided all will be cleared.
*/
clearSubwikiList(wikiId?: number): void {
if (typeof wikiId == 'undefined') {
this.subwikiListsCache = {};
} else {
delete this.subwikiListsCache[wikiId];
}
}
/**
* Save wiki contents on a page or section.
*
* @param pageId Page ID.
* @param content content to be saved.
* @param section section to get.
* @return Promise resolved with the page ID.
*/
editPage(pageId: number, content: string, section?: string, siteId?: string): Promise<number> {
return this.sitesProvider.getSite(siteId).then((site) => {
const params: any = {
pageid: pageId,
content: content
};
if (section) {
params.section = section;
}
return site.write('mod_wiki_edit_page', params).then((response) => {
return response.pageid || Promise.reject(null);
});
});
}
/**
* Get a wiki page contents.
*
* @param pageId Page ID.
* @param options Other options.
* @return Promise resolved with the page data.
*/
getPageContents(pageId: number, options: CoreCourseCommonModWSOptions = {}): Promise<any> {
return this.sitesProvider.getSite(options.siteId).then((site) => {
const params = {
pageid: pageId,
};
const preSets = {
cacheKey: this.getPageContentsCacheKey(pageId),
updateFrequency: CoreSite.FREQUENCY_SOMETIMES,
component: AddonModWikiProvider.COMPONENT,
componentId: options.cmId,
...this.sitesProvider.getReadingStrategyPreSets(options.readingStrategy), // Include reading strategy preSets.
};
return site.read('mod_wiki_get_page_contents', params, preSets).then((response) => {
return response.page || Promise.reject(null);
});
});
}
/**
* Get cache key for wiki Pages Contents WS calls.
*
* @param pageId Wiki Page ID.
* @return Cache key.
*/
protected getPageContentsCacheKey(pageId: number): string {
return this.ROOT_CACHE_KEY + 'page:' + pageId;
}
/**
* Get a wiki page contents for editing. It does not cache calls.
*
* @param pageId Page ID.
* @param section Section to get.
* @param lockOnly Just renew lock and not return content.
* @param siteId Site ID. If not defined, current site.
* @return Promise resolved with page contents.
*/
getPageForEditing(pageId: number, section?: string, lockOnly?: boolean, siteId?: string): Promise<any> {
return this.sitesProvider.getSite(siteId).then((site) => {
const params: any = {
pageid: pageId
};
if (section) {
params.section = section;
}
// This parameter requires Moodle 3.2. It saves network usage.
if (lockOnly && site.isVersionGreaterEqualThan('3.2')) {
params.lockonly = 1;
}
return site.write('mod_wiki_get_page_for_editing', params).then((response) => {
return response.pagesection || Promise.reject(null);
});
});
}
/**
* Gets the list of files from a specific subwiki.
*
* @param wikiId Wiki ID.
* @param options Other options.
* @return Promise resolved with subwiki files.
*/
getSubwikiFiles(wikiId: number, options: AddonModWikiGetSubwikiFilesOptions = {}): Promise<any[]> {
return this.sitesProvider.getSite(options.siteId).then((site) => {
const groupId = options.groupId || -1;
const userId = options.userId || 0;
const params = {
wikiid: wikiId,
groupid: groupId,
userid: userId,
};
const preSets = {
cacheKey: this.getSubwikiFilesCacheKey(wikiId, groupId, userId),
updateFrequency: CoreSite.FREQUENCY_SOMETIMES,
component: AddonModWikiProvider.COMPONENT,
componentId: options.cmId,
...this.sitesProvider.getReadingStrategyPreSets(options.readingStrategy), // Include reading strategy preSets.
};
return site.read('mod_wiki_get_subwiki_files', params, preSets).then((response) => {
return response.files || Promise.reject(null);
});
});
}
/**
* Get cache key for wiki Subwiki Files WS calls.
*
* @param wikiId Wiki ID.
* @param groupId Group ID.
* @param userId User ID.
* @return Cache key.
*/
protected getSubwikiFilesCacheKey(wikiId: number, groupId: number, userId: number): string {
return this.getSubwikiFilesCacheKeyPrefix(wikiId) + ':' + groupId + ':' + userId;
}
/**
* Get cache key for all wiki Subwiki Files WS calls.
*
* @param wikiId Wiki ID.
* @return Cache key.
*/
protected getSubwikiFilesCacheKeyPrefix(wikiId: number): string {
return this.ROOT_CACHE_KEY + 'subwikifiles:' + wikiId;
}
/**
* Get a list of subwikis and related data for a certain wiki from the cache.
*
* @param wikiId wiki Id
* @return Subwiki list and related data.
*/
getSubwikiList(wikiId: number): AddonModWikiSubwikiListData {
return this.subwikiListsCache[wikiId];
}
/**
* Get the list of Pages of a SubWiki.
*
* @param wikiId Wiki ID.
* @param options Other options.
* @return Promise resolved with wiki subwiki pages.
*/
getSubwikiPages(wikiId: number, options: AddonModWikiGetSubwikiPagesOptions = {}): Promise<any[]> {
return this.sitesProvider.getSite(options.siteId).then((site) => {
const groupId = options.groupId || -1;
const userId = options.userId || 0;
const sortBy = options.sortBy || 'title';
const sortDirection = options.sortDirection || 'ASC';
const params = {
wikiid: wikiId,
groupid: groupId,
userid: userId,
options: {
sortby: sortBy,
sortdirection: sortDirection,
includecontent: options.includeContent ? 1 : 0,
},
};
const preSets = {
cacheKey: this.getSubwikiPagesCacheKey(wikiId, groupId, userId),
updateFrequency: CoreSite.FREQUENCY_SOMETIMES,
component: AddonModWikiProvider.COMPONENT,
componentId: options.cmId,
...this.sitesProvider.getReadingStrategyPreSets(options.readingStrategy), // Include reading strategy preSets.
};
return site.read('mod_wiki_get_subwiki_pages', params, preSets).then((response) => {
return response.pages || Promise.reject(null);
});
});
}
/**
* Get cache key for wiki Subwiki Pages WS calls.
*
* @param wikiId Wiki ID.
* @param groupId Group ID.
* @param userId User ID.
* @return Cache key.
*/
protected getSubwikiPagesCacheKey(wikiId: number, groupId: number, userId: number): string {
return this.getSubwikiPagesCacheKeyPrefix(wikiId) + ':' + groupId + ':' + userId;
}
/**
* Get cache key for all wiki Subwiki Pages WS calls.
*
* @param wikiId Wiki ID.
* @return Cache key.
*/
protected getSubwikiPagesCacheKeyPrefix(wikiId: number): string {
return this.ROOT_CACHE_KEY + 'subwikipages:' + wikiId;
}
/**
* Get all the subwikis of a wiki.
*
* @param wikiId Wiki ID.
* @param options Other options.
* @return Promise resolved with subwikis.
*/
getSubwikis(wikiId: number, options: CoreCourseCommonModWSOptions = {}): Promise<any[]> {
return this.sitesProvider.getSite(options.siteId).then((site) => {
const params = {
wikiid: wikiId,
};
const preSets = {
cacheKey: this.getSubwikisCacheKey(wikiId),
updateFrequency: CoreSite.FREQUENCY_RARELY,
component: AddonModWikiProvider.COMPONENT,
componentId: options.cmId,
...this.sitesProvider.getReadingStrategyPreSets(options.readingStrategy), // Include reading strategy preSets.
};
return site.read('mod_wiki_get_subwikis', params, preSets).then((response) => {
return response.subwikis || Promise.reject(null);
});
});
}
/**
* Get cache key for get wiki subWikis WS calls.
*
* @param wikiId Wiki ID.
* @return Cache key.
*/
protected getSubwikisCacheKey(wikiId: number): string {
return this.ROOT_CACHE_KEY + 'subwikis:' + wikiId;
}
/**
* Get a wiki by module ID.
*
* @param courseId Course ID.
* @param cmId Course module ID.
* @param options Other options.
* @return Promise resolved when the wiki is retrieved.
*/
getWiki(courseId: number, cmId: number, options: CoreSitesCommonWSOptions = {}): Promise<any> {
return this.getWikiByField(courseId, 'coursemodule', cmId, options);
}
/**
* Get a wiki with key=value. If more than one is found, only the first will be returned.
*
* @param courseId Course ID.
* @param key Name of the property to check.
* @param value Value to search.
* @param options Other options.
* @return Promise resolved when the wiki is retrieved.
*/
protected getWikiByField(courseId: number, key: string, value: any, options: CoreSitesCommonWSOptions = {}): Promise<any> {
return this.sitesProvider.getSite(options.siteId).then((site) => {
const params = {
courseids: [courseId],
};
const preSets = {
cacheKey: this.getWikiDataCacheKey(courseId),
updateFrequency: CoreSite.FREQUENCY_RARELY,
component: AddonModWikiProvider.COMPONENT,
...this.sitesProvider.getReadingStrategyPreSets(options.readingStrategy), // Include reading strategy preSets.
};
return site.read('mod_wiki_get_wikis_by_courses', params, preSets).then((response) => {
if (response.wikis) {
const currentWiki = response.wikis.find((wiki) => {
return wiki[key] == value;
});
if (currentWiki) {
return currentWiki;
}
}
return Promise.reject(null);
});
});
}
/**
* Get a wiki by wiki ID.
*
* @param courseId Course ID.
* @param id Wiki ID.
* @param options Other options.
* @return Promise resolved when the wiki is retrieved.
*/
getWikiById(courseId: number, id: number, options: CoreSitesCommonWSOptions = {}): Promise<any> {
return this.getWikiByField(courseId, 'id', id, options);
}
/**
* Get cache key for wiki data WS calls.
*
* @param courseId Course ID.
* @return Cache key.
*/
protected getWikiDataCacheKey(courseId: number): string {
return this.ROOT_CACHE_KEY + 'wiki:' + courseId;
}
/**
* Gets a list of files to download for a wiki, using a format similar to module.contents from get_course_contents.
*
* @param wiki Wiki.
* @param options Other options.
* @return Promise resolved with the list of files.
*/
getWikiFileList(wiki: any, options: CoreSitesCommonWSOptions = {}): Promise<any[]> {
options.siteId = options.siteId || this.sitesProvider.getCurrentSiteId();
let files = [];
const modOptions = {
cmId: wiki.coursemodule,
...options, // Include all options.
};
return this.getSubwikis(wiki.id, modOptions).then((subwikis) => {
const promises = [];
subwikis.forEach((subwiki) => {
const subwikiOptions = {
groupId: subwiki.groupid,
userId: subwiki.userid,
...modOptions, // Include all options.
};
promises.push(this.getSubwikiFiles(subwiki.wikiid, subwikiOptions).then((swFiles) => {
files = files.concat(swFiles);
}));
});
return Promise.all(promises).then(() => {
return files;
});
});
}
/**
* Gets a list of all pages for a Wiki.
*
* @param wiki Wiki.
* @param options Other options.
* @return Page list.
*/
getWikiPageList(wiki: any, options: CoreSitesCommonWSOptions = {}): Promise<any[]> {
options.siteId = options.siteId || this.sitesProvider.getCurrentSiteId();
let pages = [];
const modOptions = {
cmId: wiki.coursemodule,
...options, // Include all options.
};
return this.getSubwikis(wiki.id, modOptions).then((subwikis) => {
const promises = [];
subwikis.forEach((subwiki) => {
promises.push(this.getSubwikiPages(subwiki.wikiid, {
groupId: subwiki.groupid,
userId: subwiki.userid,
...modOptions, // Include all options.
}).then((subwikiPages) => {
pages = pages.concat(subwikiPages);
}));
});
return Promise.all(promises).then(() => {
return pages;
});
});
}
/**
* Invalidate the prefetched content except files.
* To invalidate files, use invalidateFiles.
*
* @param moduleId The module ID.
* @param courseId Course ID.
* @param siteId Site ID. If not defined, current site.
* @return Promise resolved when done.
*/
invalidateContent(moduleId: number, courseId: number, siteId?: string): Promise<any> {
siteId = siteId || this.sitesProvider.getCurrentSiteId();
return this.getWiki(courseId, moduleId, {siteId}).then((wiki) => {
const promises = [];
promises.push(this.invalidateWikiData(courseId, siteId));
promises.push(this.invalidateSubwikis(wiki.id, siteId));
promises.push(this.invalidateSubwikiPages(wiki.id, siteId));
promises.push(this.invalidateSubwikiFiles(wiki.id, siteId));
return Promise.all(promises);
});
}
/**
* Invalidate the prefetched files.
*
* @param moduleId The module ID.
* @param siteId Site ID. If not defined, current site.
* @return Promise resolved when the files are invalidated.
*/
invalidateFiles(moduleId: number, siteId?: string): Promise<any> {
return this.filepoolProvider.invalidateFilesByComponent(siteId, AddonModWikiProvider.COMPONENT, moduleId);
}
/**
* Invalidates page content WS call for a certain page.
*
* @param pageId Wiki Page ID.
* @param siteId Site ID. If not defined, current site.
* @return Promise resolved when the data is invalidated.
*/
invalidatePage(pageId: number, siteId?: string): Promise<any> {
return this.sitesProvider.getSite(siteId).then((site) => {
return site.invalidateWsCacheForKey(this.getPageContentsCacheKey(pageId));
});
}
/**
* Invalidates all the subwiki files WS calls for a certain wiki.
*
* @param wikiId Wiki ID.
* @param siteId Site ID. If not defined, current site.
* @return Promise resolved when the data is invalidated.
*/
invalidateSubwikiFiles(wikiId: number, siteId?: string): Promise<any> {
return this.sitesProvider.getSite(siteId).then((site) => {
return site.invalidateWsCacheForKeyStartingWith(this.getSubwikiFilesCacheKeyPrefix(wikiId));
});
}
/**
* Invalidates all the subwiki pages WS calls for a certain wiki.
*
* @param wikiId Wiki ID.
* @param siteId Site ID. If not defined, current site.
* @return Promise resolved when the data is invalidated.
*/
invalidateSubwikiPages(wikiId: number, siteId?: string): Promise<any> {
return this.sitesProvider.getSite(siteId).then((site) => {
return site.invalidateWsCacheForKeyStartingWith(this.getSubwikiPagesCacheKeyPrefix(wikiId));
});
}
/**
* Invalidates all the get subwikis WS calls for a certain wiki.
*
* @param wikiId Wiki ID.
* @param siteId Site ID. If not defined, current site.
* @return Promise resolved when the data is invalidated.
*/
invalidateSubwikis(wikiId: number, siteId?: string): Promise<any> {
this.clearSubwikiList(wikiId);
return this.sitesProvider.getSite(siteId).then((site) => {
return site.invalidateWsCacheForKey(this.getSubwikisCacheKey(wikiId));
});
}
/**
* Invalidates wiki data.
*
* @param courseId Course ID.
* @param siteId Site ID. If not defined, current site.
* @return Promise resolved when the data is invalidated.
*/
invalidateWikiData(courseId: number, siteId?: string): Promise<any> {
return this.sitesProvider.getSite(siteId).then((site) => {
return site.invalidateWsCacheForKey(this.getWikiDataCacheKey(courseId));
});
}
/**
* Check if a page title is already used.
*
* @param wikiId Wiki ID.
* @param subwikiId Subwiki ID.
* @param title Page title.
* @param options Other options.
* @return Promise resolved with true if used, resolved with false if not used or cannot determine.
*/
isTitleUsed(wikiId: number, subwikiId: number, title: string, options: CoreCourseCommonModWSOptions = {}): Promise<boolean> {
// First get the subwiki.
return this.getSubwikis(wikiId, options).then((subwikis) => {
// Search the subwiki.
const subwiki = subwikis.find((subwiki) => {
return subwiki.id == subwikiId;
});
return subwiki || Promise.reject(null);
}).then((subwiki) => {
// Now get all the pages of the subwiki.
return this.getSubwikiPages(wikiId, {
groupId: subwiki.groupid,
userId: subwiki.userid,
...options, // Include all options.
});
}).then((pages) => {
// Check if there's any page with the same title.
const page = pages.find((page) => {
return page.title == title;
});
return !!page;
}).catch(() => {
return false;
});
}
/**
* Report a wiki page as being viewed.
*
* @param id Page ID.
* @param wikiId Wiki ID.
* @param name Name of the wiki.
* @param siteId Site ID. If not defined, current site.
* @return Promise resolved when the WS call is successful.
*/
logPageView(id: number, wikiId: number, name?: string, siteId?: string): Promise<any> {
const params = {
pageid: id
};
return this.logHelper.logSingle('mod_wiki_view_page', params, AddonModWikiProvider.COMPONENT, wikiId, name, 'wiki',
params, siteId);
}
/**
* Report the wiki as being viewed.
*
* @param id Wiki ID.
* @param name Name of the wiki.
* @param siteId Site ID. If not defined, current site.
* @return Promise resolved when the WS call is successful.
*/
logView(id: number, name?: string, siteId?: string): Promise<any> {
const params = {
wikiid: id
};
return this.logHelper.logSingle('mod_wiki_view_wiki', params, AddonModWikiProvider.COMPONENT, id, name, 'wiki', {},
siteId);
}
/**
* Create a new page on a subwiki.
*
* @param title Title to create the page.
* @param content Content to save on the page.
* @param options Other options.
* @return Promise resolved with page ID if page was created in server, -1 if stored in device.
*/
newPage(title: string, content: string, options: AddonModWikiNewPageOptions = {}): Promise<number> {
options.siteId = options.siteId || this.sitesProvider.getCurrentSiteId();
// Convenience function to store a new page to be synchronized later.
const storeOffline = (): Promise<number> => {
let promise;
if (options.wikiId) {
// We have wiki ID, check if there's already an online page with this title and subwiki.
promise = this.isTitleUsed(options.wikiId, options.subwikiId, title, {
cmId: options.cmId,
readingStrategy: CoreSitesReadingStrategy.PreferCache,
siteId: options.siteId,
}).catch(() => {
// Error, assume not used.
return false;
}).then((used) => {
if (used) {
return Promise.reject(this.translate.instant('addon.mod_wiki.pageexists'));
}
});
} else {
promise = Promise.resolve();
}
return promise.then(() => {
return this.wikiOffline.saveNewPage(title, content, options.subwikiId, options.wikiId, options.userId,
options.groupId, options.siteId).then(() => {
return -1;
});
});
};
if (!this.appProvider.isOnline()) {
// App is offline, store the action.
return storeOffline();
}
// Discard stored content for this page. If it exists it means the user is editing it.
return this.wikiOffline.deleteNewPage(title, options.subwikiId, options.wikiId, options.userId, options.groupId,
options.siteId).then(() => {
// Try to create it in online.
return this.newPageOnline(title, content, options).catch((error) => {
if (this.utils.isWebServiceError(error)) {
// The WebService has thrown an error, this means that the page cannot be added.
return Promise.reject(error);
} else {
// Couldn't connect to server, store in offline.
return storeOffline();
}
});
});
}
/**
* Create a new page on a subwiki. It will fail if offline or cannot connect.
*
* @param title Title to create the page.
* @param content Content to save on the page.
* @param options Other options.
* @return Promise resolved with the page ID if created, rejected otherwise.
*/
newPageOnline(title: string, content: string, options: AddonModWikiNewPageOnlineOptions = {}): Promise<number> {
return this.sitesProvider.getSite(options.siteId).then((site) => {
const params: any = {
title: title,
content: content,
contentformat: 'html',
};
const subwikiId = this.wikiOffline.convertToPositiveNumber(options.subwikiId);
const wikiId = this.wikiOffline.convertToPositiveNumber(options.wikiId);
if (subwikiId && subwikiId > 0) {
params.subwikiid = subwikiId;
} else if (wikiId) {
params.wikiid = wikiId;
params.userid = this.wikiOffline.convertToPositiveNumber(options.userId);
params.groupid = this.wikiOffline.convertToPositiveNumber(options.groupId);
}
return site.write('mod_wiki_new_page', params).then((response) => {
return response.pageid || Promise.reject(null);
});
});
}
/**
* Save subwiki list for a wiki to the cache.
*
* @param wikiId Wiki Id.
* @param subwikis List of subwikis.
* @param count Number of subwikis in the subwikis list.
* @param subwikiId Subwiki Id currently selected.
* @param userId User Id currently selected.
* @param groupId Group Id currently selected.
*/
setSubwikiList(wikiId: number, subwikis: any[], count: number, subwikiId: number, userId: number, groupId: number): void {
this.subwikiListsCache[wikiId] = {
count: count,
subwikiSelected: subwikiId,
userSelected: userId,
groupSelected: groupId,
subwikis: subwikis
};
}
/**
* Sort an array of wiki pages by title.
*
* @param pages Pages to sort.
* @param desc True to sort in descendent order, false to sort in ascendent order. Defaults to false.
* @return Sorted pages.
*/
sortPagesByTitle(pages: any[], desc?: boolean): any[] {
return pages.sort((a, b) => {
let result = a.title >= b.title ? 1 : -1;
if (desc) {
result = -result;
}
return result;
});
}
/**
* Check if a wiki has a certain subwiki.
*
* @param wikiId Wiki ID.
* @param subwikiId Subwiki ID to search.
* @param options Other options.
* @return Promise resolved with true if it has subwiki, resolved with false otherwise.
*/
wikiHasSubwiki(wikiId: number, subwikiId: number, options: CoreCourseCommonModWSOptions = {}): Promise<boolean> {
// Get the subwikis to check if any of them matches the one passed as param.
return this.getSubwikis(wikiId, options).then((subwikis) => {
const subwiki = subwikis.find((subwiki) => {
return subwiki.id == subwikiId;
});
return !!subwiki;
}).catch(() => {
// Not found, return false.
return false;
});
}
}
/**
* Options to pass to getSubwikiFiles.
*/
export type AddonModWikiGetSubwikiFilesOptions = CoreCourseCommonModWSOptions & {
userId?: number; // User to get files from.
groupId?: number; // Group to get files from.
};
/**
* Options to pass to getSubwikiPages.
*/
export type AddonModWikiGetSubwikiPagesOptions = CoreCourseCommonModWSOptions & {
userId?: number; // User to get pages from.
groupId?: number; // Group to get pages from.
sortBy?: string; // The attribute to sort the returned list. Defaults to 'title'.
sortDirection?: string; // Direction to sort the returned list (ASC | DESC). Defaults to 'ASC'.
includeContent?: boolean; // Whether the pages have to include their content.
};
/**
* Options to pass to newPageOnline.
*/
export type AddonModWikiNewPageOnlineOptions = {
subwikiId?: number; // Subwiki ID. If not defined, wikiId, userId and groupId should be defined.
wikiId?: number; // Wiki ID. Optional, will be used to create a new subwiki if subwikiId not supplied.
userId?: number; // User ID. Optional, will be used to create a new subwiki if subwikiId not supplied.
groupId?: number; // Group ID. Optional, will be used to create a new subwiki if subwikiId not supplied.
siteId?: string; // Site ID. If not defined, current site.
};
/**
* Options to pass to newPage.
*/
export type AddonModWikiNewPageOptions = AddonModWikiNewPageOnlineOptions & {
cmId?: number; // Module ID.
};