OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
openproject/frontend/app/typings/open-project.typings.d.ts

123 lines
2.7 KiB

//-- copyright
// OpenProject is a project management system.
// Copyright (C) 2012-2015 the OpenProject Foundation (OPF)
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License version 3.
//
// OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
// Copyright (C) 2006-2013 Jean-Philippe Lang
// Copyright (C) 2010-2013 the ChiliProject Team
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// See doc/COPYRIGHT.rdoc for more details.
//++
/**
* API interfaces
*
* @see {@link http://opf.github.io/apiv3-doc/|Api V3 documentation}
*/
declare namespace api {
/**
* API v3
*/
namespace v3 {
interface Result {
_links:any;
_embedded:any;
_type:string;
}
interface Collection extends Result {
total:number;
pageSize:number;
count:number;
offset:number;
groups:any;
totalSums:any;
}
interface Duration extends String {
}
interface Formattable {
format:string;
raw:string;
html:string;
}
}
}
/**
* OpenProject interfaces
*/
interface Function {
$link?:any;
name:string;
_type:string;
}
interface JQuery {
topShelf:any;
atwho:any;
mark:any;
}
declare var Factory:any;
declare namespace op {
/**
* General components
*/
interface I18n {
t(translateId:string, parameters?:any):string;
lookup(translateId:string):boolean|undefined;
locale:string;
}
interface CacheService {
temporaryCache():any;
localStorage():any;
memoryStorage():any;
customCache(identifier:any, params:any):any;
isCacheDisabled():any;
enableCaching():any;
disableCaching():any;
cachedPromise(promiseFn:any, key:any, options?:any):any;
}
interface FieldSchema {
type:string;
writable:boolean;
allowedValues:any;
required?:boolean;
hasDefault:boolean;
name?:string;
}
interface QueryParams {
offset?:number;
pageSize?:number;
filters?:any[];
groupBy?:string;
showSums?:boolean;
sortBy?:any[];
}
}