Interface RemoteLinkData

RemoteLinkData

Data related to a single Remote Link.

interface RemoteLinkData {
    actionIds?: string[];
    associations?: ({
        associationType: "issueKeys";
        values: string[];
    } & {
        [key: string]: unknown;
    } | {
        associationType: "serviceIdOrKeys";
        values: string[];
    } & {
        [key: string]: unknown;
    })[];
    attributeMap?: {
        [key: string]: string;
    };
    description?: string;
    displayName: string;
    id: string;
    lastUpdated: string;
    schemaVersion?: "1.0";
    status?: {
        appearance:
            | "default"
            | "inprogress"
            | "new"
            | "removed"
            | "success"
            | "prototype"
            | "moved";
        label: string;
    } & {
        [key: string]: unknown;
    };
    type:
        | "document"
        | "alert"
        | "other"
        | "test"
        | "prototype"
        | "security"
        | "logFile"
        | "coverage"
        | "bugReport";
    updateSequenceNumber: number;
    url: string;
}

Hierarchy

  • Record<string, unknown>
    • RemoteLinkData

Properties

actionIds? associations? attributeMap? description? displayName id lastUpdated schemaVersion? status? type updateSequenceNumber url

Properties

OptionalactionIds

actionIds?: string[]

Optional list of actionIds. They are associated with the actions the provider is able to provide when they registered. Indicates which actions this Remote Link has.

If any actions have a templateUrl that requires string substitution, then attributeMap must be passed in.

Example

[
  "action-111-222-333",
  "action-444-555-666"
]

Optionalassociations

associations?: ({
    associationType: "issueKeys";
    values: string[];
} & {
    [key: string]: unknown;
} | {
    associationType: "serviceIdOrKeys";
    values: string[];
} & {
    [key: string]: unknown;
})[]

The entities to associate the Remote Link information with.

OptionalattributeMap

attributeMap?: {
    [key: string]: string;
}

Map of key/values (string to string mapping). This is used to build the urls for actions from the templateUrl the provider registered their available actions with.

Optionaldescription

description?: string

An optional description to attach to this Remote Link.

This may be anything that makes sense in your system.

Example

Remote Link #42 with more information in this description

displayName

displayName: string

The human-readable name for the Remote Link.

Will be shown in the UI.

Example

Remote Link #42

id

id: string

The identifier for the Remote Link. Must be unique for a given Provider.

Example

111-222-333

lastUpdated

lastUpdated: string

The last-updated timestamp to present to the user as a summary of when Remote Link was last updated.

Example

2018-01-20T23:27:25.000Z

OptionalschemaVersion

schemaVersion

The schema version used for this data.

Placeholder to support potential schema changes in the future.

Example

1

Optionalstatus

status?: {
    appearance:
        | "default"
        | "inprogress"
        | "new"
        | "removed"
        | "success"
        | "prototype"
        | "moved";
    label: string;
} & {
    [key: string]: unknown;
}

RemoteLinkStatus

The status of a Remote Link.

Type declaration

  • appearance:
        | "default"
        | "inprogress"
        | "new"
        | "removed"
        | "success"
        | "prototype"
        | "moved"

    Appearance is a fixed set of appearance types affecting the colour of the status lozenge in the UI. The colours they correspond to are equivalent to atlaskit's Lozenge component.

    Example

    inprogress
  • label: string

    The human-readable description for the Remote Link status.

    Will be shown in the UI.

    Example

    ANOMALOUS

type

type:
    | "document"
    | "alert"
    | "other"
    | "test"
    | "prototype"
    | "security"
    | "logFile"
    | "coverage"
    | "bugReport"

The type of the Remote Link. The current supported types are 'document', 'alert', 'test', 'security', 'logFile', 'prototype', 'coverage', 'bugReport' and 'other'

Example

security

updateSequenceNumber

updateSequenceNumber: number

An ID used to apply an ordering to updates for this Remote Link in the case of out-of-order receipt of update requests.

It must be a monotonically increasing number. For example, epoch time could be one way to generate the updateSequenceNumber.

Updates for a Remote Link that is received with an updateSqeuenceNumber less than or equal to what is currently stored will be ignored.

Example

1523494301448

url

url: string

The URL to this Remote Link in your system.

Settings

Member Visibility

On This Page

Properties