connect.models.Agreement - Haxe SDK Documentation

Static methods

`staticget(id:String):Agreement`

Returns:

The Agreement with the given id, or null if it was not found.

`staticlist(filters:Query):Collection<Agreement>`

Lists all agreements that match the given filters. Supported filters are:

type
owner__id

Returns:

A Collection of Agreements.

Constructor

`new()`

Variables

`active:Bool`

State of the version.

`agreements:Collection<Agreement>`

Program agreements can have distribution agreements associated with them.

`author:User`

Reference to the user who created the version.

`link:String`

Url to the document.

`marketplace:Marketplace`

Reference to marketplace object (for distribution agreement).

`name:String`

Name of Agreement.

`parent:Agreement`

Reference to the parent program agreement (for distribution agreement).

`title:String`

Title of the agreement.

`type:String`

Type of the agreement. One of: distribution, program, service.

`updated:DateTime`

Date of the update of the agreement. It can be creation of the new version, change of the field, etc. (any change).

Methods

`getVersion(version:Int):Agreement`

Returns:

Agreement Returns the specified version for this Agreement, or null if it was not found.

`listSubAgreements():Collection<Agreement>`

Lists all sub agreements linked to this Agreement.

Returns:

Collection

`listVersions():Collection<Agreement>`

`register():Agreement`

Registers a new Agreement on Connect, based on the data of this Agreement.

Returns:

The new Agreement, or null if it couldn't be created

`registerSubAgreement(agreement:Agreement):Agreement`

Registers a new Agreement on Connect and links it to this Agreement.

Returns:

The new Agreement, or null if it couldn't be created

`registerVersion():Agreement`

Registers a new version on Connect, based on the data of this Agreement.

Returns:

The new version, or null if it couldn't be registered

`remove():Bool`

Removes this Agreement from Connect.

Returns:

Bool If agreement could be removed, returns true. Otherwise, returns false.

`removeVersion(version:Int):Bool`

Removes the specified version from this agreement on Connect.

Parameters:

`version`	The version to remove.

`update():Agreement`

Updates the agreement in Connect platform with the data changed in this model.

You should reassign your agreement with the object returned by this method, so the next time you call update on the object, the SDK knows the fields that already got updated in a previous call, like this:

agreement = agreement.update();

Returns:

The Agreement returned from the server, which should contain the same data as this Agreement, or null if the updating fails.

class Agreement

package connect.models

extends IdModel › Model

Static methods

staticget(id:String):Agreement

staticlist(filters:Query):Collection<Agreement>

Constructor

new()

Variables

active:Bool

agreements:Collection<Agreement>

author:User

created:DateTime

description:String

link:String

marketplace:Marketplace

name:String

owner:Account

parent:Agreement

stats:AgreementStats

title:String

type:String

updated:DateTime

version:Int

versionContracts:Int

versionCreated:DateTime

Methods

getVersion(version:Int):Agreement

listSubAgreements():Collection<Agreement>

listVersions():Collection<Agreement>

register():Agreement

registerSubAgreement(agreement:Agreement):Agreement

registerVersion():Agreement

remove():Bool

removeVersion(version:Int):Bool

update():Agreement

Inherited Variables

Defined by IdModel

id:String

Inherited Methods

Defined by Model

toObject():Dynamic

toString():String

`staticget(id:String):Agreement`

`staticlist(filters:Query):Collection<Agreement>`

`new()`

`active:Bool`

`agreements:Collection<Agreement>`

`author:User`

`created:DateTime`

`description:String`

`link:String`

`marketplace:Marketplace`

`name:String`

`owner:Account`

`parent:Agreement`

`stats:AgreementStats`

`title:String`

`type:String`

`updated:DateTime`

`version:Int`

`versionContracts:Int`

`versionCreated:DateTime`

`getVersion(version:Int):Agreement`

`listSubAgreements():Collection<Agreement>`

`listVersions():Collection<Agreement>`

`register():Agreement`

`registerSubAgreement(agreement:Agreement):Agreement`

`registerVersion():Agreement`

`remove():Bool`

`removeVersion(version:Int):Bool`

`update():Agreement`

`id:String`

`toObject():Dynamic`

`toString():String`