Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "transactions"

Index

Type aliases

Functions

Object literals

Type aliases

phid

phid: string

Functions

Const comment

  • comment(value: string): object

Const edit

  • edit(value: string): object

  • Change the edit policy of the object.

    Parameters

    • value: string

    Returns object

Const mfa

  • mfa(value: string): object

  • Sign this transaction group with MFA.

    Parameters

    • value: string

    Returns object

Const title

  • title(value: string): object

  • Change the title of the object

    Parameters

    • value: string

    Returns object

Const view

  • view(value: string): object

  • Change the view policy of the object.

    Parameters

    • value: string

    Returns object

Object literals

Const projects

projects: object

add

  • add(value: Array<phid>): object

remove

  • remove(value: Array<phid>): object

set

  • set(value: Array<phid>): object

Const subscribers

subscribers: object

add

  • add(value: Array<phid>): object

remove

  • remove(value: Array<phid>): object

set

  • set(value: Array<phid>): object

  • Set subscribers, overwriting current value

    Parameters

    • value: Array<phid>

    Returns object

Const transactions

transactions: object

badge

badge: object

Badge edit transactions

comment

comment: comment = comment

mfa

mfa: mfa = mfa

subscribers

subscribers: object = subscribers

Type declaration

  • add: function
    • add(value: Array<phid>): object
  • remove: function
    • remove(value: Array<phid>): object
  • set: function
    • set(value: Array<phid>): object

    • Set subscribers, overwriting current value

      Parameters

      • value: Array<phid>

      Returns object

award

  • award(value: Array<phid>): object

description

  • description(value: string): object

  • Badge long description

    Parameters

    • value: string

    Returns object

edit

  • edit(value: phid): object

flavor

  • flavor(value: string): object

  • Short description of the badge.

    Parameters

    • value: string

    Returns object

icon

name

  • name(value: string): object

quality

  • quality(value: "poor" | "common" | "uncommon" | "rare" | "epic" | "legendary" | "heirloom"): object

  • Color and rarity of the badge.

    Parameters

    • value: "poor" | "common" | "uncommon" | "rare" | "epic" | "legendary" | "heirloom"

    Returns object

revoke

  • revoke(value: Array<phid>): object

conpherence

conpherence: object

Conpherence edit transactions

comment

comment: comment = comment

edit

edit: edit = edit

mfa

mfa: mfa = mfa

view

view: view = view

name

  • name(value: string): object

topic

  • topic(value: string): object

participants

participants: object

add

  • add(value: Array<phid>): object

remove

  • remove(value: Array<phid>): object

set

  • set(value: Array<phid>): object

maniphest

maniphest: object

Maniphest edit transactions

comment

comment: comment = comment

edit

edit: edit = edit

mfa

mfa: mfa = mfa

projects

projects: object = projects

Type declaration

  • add: function
    • add(value: Array<phid>): object
  • remove: function
    • remove(value: Array<phid>): object
  • set: function
    • set(value: Array<phid>): object

subscribers

subscribers: object = subscribers

Type declaration

  • add: function
    • add(value: Array<phid>): object
  • remove: function
    • remove(value: Array<phid>): object
  • set: function
    • set(value: Array<phid>): object

    • Set subscribers, overwriting current value

      Parameters

      • value: Array<phid>

      Returns object

title

title: title = title

view

view: view = view

column

  • column(value: Array<phid>): object

  • Move a task to one or more workboard columns.

    You can use this transaction type to create a task into a particular workboard column, or move an existing task between columns.

    Parameters

    • value: Array<phid>

    Returns object

custom

  • custom(type: string, value: any): object

  • Use this to set transactions with custom fields. The type argument is the transaction type name, the value is value. An example transaction type name is custom.myfield

    Parameters

    • type: string
    • value: any

    Returns object

    • type: string
    • value: any

description

  • description(value: string): object

  • Update the task description

    Parameters

    • value: string

    Returns object

owner

  • owner(value: phid): object

parent

  • parent(value: phid): object

priority

  • priority(value: "unbreak" | "triage" | "high" | "normal" | "low" | "wishlist"): object

  • Change the priority of the task

    Parameters

    • value: "unbreak" | "triage" | "high" | "normal" | "low" | "wishlist"

    Returns object

space

  • space(value: phid): object

status

  • status(value: "open" | "resolved" | "wontfix" | "invalid" | "duplicate" | "spite" | string): object

  • Change the task status

    Parameters

    • value: "open" | "resolved" | "wontfix" | "invalid" | "duplicate" | "spite" | string

    Returns object

subtype

  • subtype(value: "default" | "bug" | "feature" | string): object

  • Change the object subtype

    Parameters

    • value: "default" | "bug" | "feature" | string

    Returns object

commits

commits: object

add

  • add(value: Array<phid>): object

  • Change the related commits for this task

    Parameters

    • value: Array<phid>

    Returns object

remove

  • remove(value: Array<phid>): object

  • Remove the related commits for this task

    Parameters

    • value: Array<phid>

    Returns object

set

  • set(value: Array<phid>): object

  • Set the related commits for this task

    Parameters

    • value: Array<phid>

    Returns object

parents

parents: object

add

  • add(value: Array<phid>): object

remove

  • remove(value: Array<phid>): object

set

  • set(value: Array<phid>): object

subtasks

subtasks: object

add

  • add(value: Array<phid>): object

remove

  • remove(value: Array<phid>): object

set

  • set(value: Array<phid>): object

paste

paste: object

Paste edit transactions

comment

comment: comment = comment

edit

edit: edit = edit

mfa

mfa: mfa = mfa

projects

projects: object = projects

Type declaration

  • add: function
    • add(value: Array<phid>): object
  • remove: function
    • remove(value: Array<phid>): object
  • set: function
    • set(value: Array<phid>): object

subscribers

subscribers: object = subscribers

Type declaration

  • add: function
    • add(value: Array<phid>): object
  • remove: function
    • remove(value: Array<phid>): object
  • set: function
    • set(value: Array<phid>): object

    • Set subscribers, overwriting current value

      Parameters

      • value: Array<phid>

      Returns object

title

title: title = title

view

view: view = view

language

  • language(value: lang): object

space

  • space(value: string): object

  • Shift the object between spaces

    Parameters

    • value: string

    Returns object

status

  • status(value: "active" | "archived"): object

  • Active or archive the paste

    Parameters

    • value: "active" | "archived"

    Returns object

text

  • text(value: string): object

portal

portal: object

Portal edit transactions

edit

edit: edit = edit

mfa

mfa: mfa = mfa

projects

projects: object = projects

Type declaration

  • add: function
    • add(value: Array<phid>): object
  • remove: function
    • remove(value: Array<phid>): object
  • set: function
    • set(value: Array<phid>): object

view

view: view = view

name

  • name(value: string): object

project

project: object

Project edit transactions

edit

edit: edit = edit

mfa

mfa: mfa = mfa

view

view: view = view

color

  • color(value: "red" | "orange" | "yellow" | "green" | "blue" | "indigo" | "violet" | "pink" | "grey" | "checkered"): object

  • Change the project tag color

    Parameters

    • value: "red" | "orange" | "yellow" | "green" | "blue" | "indigo" | "violet" | "pink" | "grey" | "checkered"

    Returns object

description

  • description(value: string): object

  • Short project description

    Parameters

    • value: string

    Returns object

icon

  • icon(value: "project" | "tag" | "policy" | "group" | "folder" | "timeline" | "goal" | "release" | "bugs" | "cleanup" | "umbrella" | "communication" | "organization" | "infrastructure" | "account" | "experimental"): object

  • Change the project icon

    Parameters

    • value: "project" | "tag" | "policy" | "group" | "folder" | "timeline" | "goal" | "release" | "bugs" | "cleanup" | "umbrella" | "communication" | "organization" | "infrastructure" | "account" | "experimental"

    Returns object

join

  • join(value: string): object

  • Change the join policy of the object.

    Parameters

    • value: string

    Returns object

milestone

  • milestone(value: phid): object

  • Choose a parent project to create a new milestone for.

    Parameters

    Returns object

name

  • name(value: string): object

  • New project name or rename

    Parameters

    • value: string

    Returns object

parent

  • parent(value: phid): object

  • Choose a parent project to create a subproject beneath.

    Parameters

    Returns object

slugs

  • slugs(value: Array<string>): object

  • Change project slugs

    Parameters

    • value: Array<string>

    Returns object

space

  • space(value: phid): object

subtype

  • subtype(value: "default" | string): object

members

members: object

add

  • add(value: Array<phid>): object

remove

  • remove(value: Array<phid>): object

set

  • set(value: Array<phid>): object

user

user: object

User edit transactions

approved

  • approved(value: boolean): object

  • Approve or reject the user

    Parameters

    • value: boolean

      true to approve the user

    Returns object

blurb

  • blurb(value: string): object

  • Short blurb about the user

    Parameters

    • value: string

    Returns object

disabled

  • disabled(value: boolean): object

  • Disable or enable the user

    Parameters

    • value: boolean

      true to disable

    Returns object

icon

  • icon(value: "person" | "engineering" | "operations" | "resources" | "camera" | "music" | "spy" | "android" | "relationships" | "administration" | "security" | "logistics" | "research" | "analysis" | "executive" | "animal"): object

  • User icon to accompany their title.

    Parameters

    • value: "person" | "engineering" | "operations" | "resources" | "camera" | "music" | "spy" | "android" | "relationships" | "administration" | "security" | "logistics" | "research" | "analysis" | "executive" | "animal"

    Returns object

mfa

  • mfa(value: boolean): object

  • Sign the transaction group with MFA

    Parameters

    • value: boolean

    Returns object

realName

  • realName(value: string): object

  • Stores the real name of the user, like "Abraham Lincoln".

    Parameters

    • value: string

    Returns object

title

  • title(value: string): object

  • User title, like "CEO" or "Assistant to the Manager".

    Parameters

    • value: string

    Returns object

Generated using TypeDoc