cityworks
    Preparing search index...

    Class General

    A plugin that contains "general" methods for a Cityworks install

    Index

    Methods

    • Add Holidays

      Parameters

      • holiday: Date

        The holiday's date

      • description: string

        The holiday's name/description

      Returns Promise<unknown>

      Returns Promise object that represents a

    • Find out if the current user is watching a particular activity (case, task, null [as a string])

      Parameters

      • activityType: any

        which activity type the following ID will be for.

      • activityId: number

        activity Case or CaseTask (task instance) ID to check

      Returns Promise<unknown>

      Returns Promise object that represents a boolean indicating the currently authenticated user is watching the provided activity

    • Delete Holidays

      Parameters

      • holidays: Date[]

        List of datetimes which should have holidays deleted

      Returns Promise<unknown>

      Returns Promise object that represents a

    • Get CwMetatData by Type and CwSid

      Parameters

      • ids: number[]
      • table: string

      Returns Promise<unknown>

      Returns Promise object that represents a

    • Get recent history for authenticated user

      Returns Promise<unknown>

      Returns Promise object that represents a collection of RecentActivity objects

    • Get Holidays

      Parameters

      • startDate: Date

        Date to search for Holidays, including this date.

      • OptionalendDate: Date

        If not specified, Holidays on startDate are returned. If specified, Holidays on startDate up to, but not including endDate are returned.

      Returns Promise<unknown>

      Returns Promise object that represents a list of the holiday(s) found

    • Get cost summary for WorkOrder entities

      Parameters

      • object_ids: number[]

      Returns Promise<unknown>

      Returns Promise object that represents a

    • Get notifications for currently authenticated user

      Returns Promise<unknown>

      Returns Promise object that represents a collection of available notifications

    • Get cost summary for WorkOrder entities selected through a search definition

      Parameters

      • search_id: number

      Returns Promise<unknown>

      Returns Promise object that represents a