MOBILE-3565 services: Add site info cron handler

main
Pau Ferrer Ocaña 2020-10-08 23:11:44 +02:00
parent d11b7ab657
commit 7aaf213889
1 changed files with 62 additions and 0 deletions

View File

@ -0,0 +1,62 @@
// (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 { CoreCronHandler } from '@services/cron';
import { CoreSites } from '@services/sites';
/**
* Cron handler to update site info every certain time.
*/
@Injectable()
export class CoreSiteInfoCronHandler implements CoreCronHandler {
name = 'CoreSiteInfoCronHandler';
/**
* Execute the process.
* Receives the ID of the site affected, undefined for all sites.
*
* @param siteId ID of the site affected, undefined for all sites.
* @return Promise resolved when done, rejected on failure.
*/
async execute(siteId?: string): Promise<void> {
if (!siteId) {
const siteIds = await CoreSites.instance.getSitesIds();
await Promise.all(siteIds.map((siteId) => CoreSites.instance.updateSiteInfo(siteId)));
} else {
await CoreSites.instance.updateSiteInfo(siteId);
}
}
/**
* Returns handler's interval in milliseconds. Defaults to CoreCronDelegate.DEFAULT_INTERVAL.
*
* @return Interval time (in milliseconds).
*/
getInterval(): number {
return 10800000; // 3 hours.
}
/**
* Check whether it's a synchronization process or not. True if not defined.
*
* @return Whether it's a synchronization process or not.
*/
isSync(): boolean {
return false;
}
}