api.backend.ProjectApi

A project allows you to access entries, languages and versions.

Use a project to alter content.

Constructor

`@:keepnew (project:Project, api:Api)`

Variables

`@:keepread onlycontentModified:Float`

Returns a timestamp of the last time any content in this project was modified

`@:keepread onlyid:Int`

Get the project id

`@:keepread onlykey:String`

Get the project key

`@:keepread onlylanguages:Map<String, String>`

Get the project's languages

`@:keepread onlyname:String`

Get the project name

`@:keepread onlytags:Array<String>`

Get all tags used in this project

Methods

`@:keepaddEntry (data:EntryRequest):EntryApi`

Create a new entry

`@:keepgetEntryByID (id:Int):EntryApi`

Get a single entry by id

`@:keepgetEntryByKey (key:String):EntryApi`

Get an entry by key

`@:keepgetEntryByPath (path:String, language:String):EntryApi`

Returns an EntryApi instance based on an path. The path is expected to exactly match the full_path of an Entry. Strip any base dirs or query before requesting.

`@:has_untyped@:keepgetFilesByQuery (query:String):Array<FileApi>`

Search for a file by name

`@:has_untyped@:keepgetFilesByTag (tag:String):Array<FileApi>`

Get all files for a given tag

`@:has_untyped@:keepgetLanguagesByQuery (language:String, query:String):Array<EntryLanguageApi>`

Search for an entry by title

`@:has_untyped@:keepgetTopEntries ():Array<EntryApi>`

Fetch root entries

`@:keepremoveEntry (id:Int):ProjectApi`

Remove an entry by id

`@:keepsetConfig (data:Dynamic):ProjectApi`

Change this project's config

`@:keepsetEntryOrder (data:Array<EntryOrder>):ProjectApi`

Set order to a list of entries

class ProjectApi

package api.backend

implements SwitchContext