Interface SrInterface

interface SrInterface {
    atlaskit: SrAtlaskit;
    checkIsSameUser: ((user1, user2) => boolean);
    common: __module;
    convertSecondsToJiraTime: ((seconds, unit, isWithDimension?) => Promise<string>);
    date: date;
    dateIsAfterToday: ((date) => boolean);
    dateIsBeforeToday: ((date) => boolean);
    dateIsToday: ((date) => boolean);
    fields: Mutable<fields>;
    getAllFieldsValues: (<T>() => Promise<T[]>);
    getAllProjects: (() => Promise<ProjectDto[]>);
    getAppInnerHeight: (() => Promise<number>);
    getCommentsByIssue: ((issueIdOrKey) => Promise<any[]>);
    getCommentsByJQL: ((jql) => Promise<any[]>);
    getCurrentUser: (() => Promise<unknown>);
    getDataByFieldName: (<T>(name) => Promise<T>);
    getFieldValue: (<T>(type, value) => Promise<T | T[]>);
    getHostBaseUrl: (() => Promise<string>);
    getIssuesByJQL: ((jql, fields?, expand?) => Promise<JiraIssue[]>);
    getIssuesCountByJQL: ((jql) => Promise<number>);
    getJiraImage: ((url) => Promise<any>);
    getReport: (() => Promise<unknown>);
    getValueByFieldName: (<T>(name) => Promise<T>);
    isCloud: boolean;
    jira: jira;
    lib: SrLibs;
    math: math;
    pivotopia: pivotopia;
    request: SrRequestFunction;
    tabulator: tabulator;
    text: text;
    time: time;
    tm: __module;
    version: string;
    worklog: Mutable<worklog>;
    mock(mockConfig): void;
    pdfDoc(doc): void;
    pdfOptions(options): void;
    render(context?, callback?): void | Promise<void>;
}

Implemented by

Properties

atlaskit checkIsSameUser common convertSecondsToJiraTime date dateIsAfterToday dateIsBeforeToday dateIsToday fields getAllFieldsValues getAllProjects getAppInnerHeight getCommentsByIssue getCommentsByJQL getCurrentUser getDataByFieldName getFieldValue getHostBaseUrl getIssuesByJQL getIssuesCountByJQL getJiraImage getReport getValueByFieldName isCloud jira lib math pivotopia request tabulator text time tm version worklog

Methods

mock pdfDoc pdfOptions render

Properties

atlaskit

atlaskit: SrAtlaskit

checkIsSameUser

checkIsSameUser: ((user1, user2) => boolean)

Type declaration

Deprecated

use jira.checkIsSameUser instead

common

common: __module

convertSecondsToJiraTime

convertSecondsToJiraTime: ((seconds, unit, isWithDimension?) => Promise<string>)

Type declaration

    • (seconds, unit, isWithDimension?): Promise<string>

    • Parameters

      • seconds: number
      • unit: "days" | "hours" | "minutes" | "prettyPrint"
      • isWithDimension: boolean = true

      Returns Promise<string>

Deprecated

use time.convertSecondsToJiraTime instead

date

date: date

dateIsAfterToday

dateIsAfterToday: ((date) => boolean)

Type declaration

    • (date): boolean

    • Parameters

      • date: MomentInput

      Returns boolean

Deprecated

use dates.checkIsAfterToday instead

dateIsBeforeToday

dateIsBeforeToday: ((date) => boolean)

Type declaration

    • (date): boolean

    • Parameters

      • date: MomentInput

      Returns boolean

Deprecated

use dates.checkIsBeforeToday instead

dateIsToday

dateIsToday: ((date) => boolean)

Type declaration

    • (date): boolean

    • Parameters

      • date: MomentInput

      Returns boolean

Deprecated

use dates.checkIsToday instead

fields

fields: Mutable<fields>

getAllFieldsValues

getAllFieldsValues: (<T>() => Promise<T[]>)

Type declaration

    • <T>(): Promise<T[]>

    • Type Parameters

      • T extends unknown

      Returns Promise<T[]>

Deprecated

use dates.checkIsBeforeToday instead

getAllProjects

getAllProjects: (() => Promise<ProjectDto[]>)

Type declaration

Deprecated

use jira.getAllProjects instead

getAppInnerHeight

getAppInnerHeight: (() => Promise<number>)

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

getCommentsByIssue

getCommentsByIssue: ((issueIdOrKey) => Promise<any[]>)

Type declaration

    • (issueIdOrKey): Promise<any[]>

    • Parameters

      • issueIdOrKey: string

      Returns Promise<any[]>

Deprecated

use jira.getCommentsByIssue instead

getCommentsByJQL

getCommentsByJQL: ((jql) => Promise<any[]>)

Type declaration

    • (jql): Promise<any[]>

    • Parameters

      • jql: string

      Returns Promise<any[]>

Deprecated

use jira.getCommentsByJQL instead

getCurrentUser

getCurrentUser: (() => Promise<unknown>)

Type declaration

    • (): Promise<unknown>

    • Returns Promise<unknown>

Deprecated

use jira.getCurrentUser instead

getDataByFieldName

getDataByFieldName: (<T>(name) => Promise<T>)

Type declaration

    • <T>(name): Promise<T>

    • Type Parameters

      • T extends unknown

      Parameters

      • name: string

      Returns Promise<T>

Deprecated

use fields.getDataByFieldName instead

getFieldValue

getFieldValue: (<T>(type, value) => Promise<T | T[]>)

Type declaration

    • <T>(type, value): Promise<T | T[]>

    • Type Parameters

      • T extends unknown

      Parameters

      • type: FieldTypes
      • value: any

      Returns Promise<T | T[]>

Deprecated

use fields.getFieldValue instead

getHostBaseUrl

getHostBaseUrl: (() => Promise<string>)

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

Deprecated

use jira.getHostBaseUrl instead

getIssuesByJQL

getIssuesByJQL: ((jql, fields?, expand?) => Promise<JiraIssue[]>)

Type declaration

    • (jql, fields?, expand?): Promise<JiraIssue[]>

    • Parameters

      • jql: string
      • Optional fields: string
      • Optional expand: string

      Returns Promise<JiraIssue[]>

Deprecated

use jira.getIssuesByJQL instead

getIssuesCountByJQL

getIssuesCountByJQL: ((jql) => Promise<number>)

Type declaration

    • (jql): Promise<number>

    • Parameters

      • jql: string

      Returns Promise<number>

Deprecated

use jira.getIssuesCountByJQL instead

getJiraImage

getJiraImage: ((url) => Promise<any>)

Type declaration

    • (url): Promise<any>

    • Parameters

      • url: string

      Returns Promise<any>

Deprecated

use jira.getJiraImage instead

getReport

getReport: (() => Promise<unknown>)

Type declaration

    • (): Promise<unknown>

    • Returns Promise<unknown>

getValueByFieldName

getValueByFieldName: (<T>(name) => Promise<T>)

Type declaration

    • <T>(name): Promise<T>

    • Type Parameters

      • T extends unknown

      Parameters

      • name: string

      Returns Promise<T>

Deprecated

use fields.getValueByFieldName instead

Readonly isCloud

isCloud: boolean

jira

jira: jira

lib

lib: SrLibs

math

math: math

pivotopia

pivotopia: pivotopia

request

request: SrRequestFunction

tabulator

tabulator: tabulator

text

text: text

time

time: time

tm

tm: __module

Readonly version

version: string

worklog

worklog: Mutable<worklog>

Methods

mock

pdfDoc

pdfOptions

render

Settings

Member Visibility

Theme

On This Page

atlaskitcheckIsSameUsercommonconvertSecondsToJiraTimedatedateIsAfterTodaydateIsBeforeTodaydateIsTodayfieldsgetAllFieldsValuesgetAllProjectsgetAppInnerHeightgetCommentsByIssuegetCommentsByJQLgetCurrentUsergetDataByFieldNamegetFieldValuegetHostBaseUrlgetIssuesByJQLgetIssuesCountByJQLgetJiraImagegetReportgetValueByFieldNameisCloudjiralibmathpivotopiarequesttabulatortexttimetmversionworklogmockpdfDocpdfOptionsrender