Bluestep JS Documentation
    Preparing search index...

    Class Finder

    Used to find and give types to various objects given their string representation of their id.

    Example: ```javascript const baseRecord = B.find.baseRecord("444666") ```

    Index

    Constructors

    constructor

    Methods

    alert alertByUserAssignedId baseObject baseRecord document documentVersions entry fieldMetaData folder formEntry formMetaData mergeReport organization query recordContainer report securityGroup securityGroupByFormulaId unit user userByUsername webApplication

    Constructors

    Methods

    • Find an [[Alert]] by its [[Id.shortId]] or a full id as a string

      Parameters

      • id: string

        Value representing a full or short id of an [[Alert]].

      Returns Alert

      const alert = B.find.alert('5');

    • Find an alert by the alert's user assigned identifier

      Parameters

      • userAssignedId: string

        Alert's assigned user id

      Returns Alert

      const alert = B.findAlert('BobAlert');

    • Find an object by its full [[Id]] or its [[Id.shortId]] and [[Id.classId]]

      Type Parameters

      Parameters

      • id: string | Id<T>

        Value representing a full or short id of an object.

      • OptionalclassType: string | number

        Required when id represents a short id.

      Returns BaseObject<T>

      const user = B.find.baseObject('222222___5');

      const user = B.find.baseObject(B.toId('222222___5'));```

      

      const user = B.find.baseObject('5', 222222);

      const user = B.find.baseObject('5', 'myassn.user.User');

      const nameForm = B.find.baseObject(B.toAltId('_formName', 'nameAndEmail', 1000001));```

    • Find a [[Relate.BaseRecord]] by its [[Id.shortId]] or a full id as a string

      Parameters

      • id: string

        Value representing a full or short id of a [[Relate.BaseRecord]].

      Returns BaseRecord<any>

      const baseRecord = B.find.baseRecord('5');

    • Find a [[Document]] by its [[Id.shortId]] or a full id as a string

      Parameters

      • id: string

        Value representing a full or short id of a [[Document]].

      Returns Document

      const document = B.find.document('5');

    • Find a [[DocumentVersions]] by its [[Id.shortId]] or a full id as a string

      Parameters

      • id: string

        Value representing a full or short id of a [[DocumentVersions]].

      Returns DocumentVersions

      const document = B.find.documentVersions('5');

    entry

    • entry(id: string): Bluestep.Relate.Entry

      Find a [[Relate.Entry]] by its [[Id.shortId]] or a full id as a string

      Parameters

      • id: string

        Value representing a full or short id of a [[Relate.Entry]].

      Returns Bluestep.Relate.Entry

      const entry = B.find.entry('5');

    • Find a [[Relate.FieldMetaData]] by its [[Id.shortId]] or a full id as a string

      Parameters

      • id: string

        Value representing a full or short id of a [[Relate.FormMetaData]].

      Returns FormMetaData

      const form = B.find.formMetaData('5');

    • Find a [[Folder]] by its [[Id.shortId]] or a full id as a string

      Parameters

      • id: string

        Value representing a full or short id of a [[Folder]].

      Returns Folder

      const folder = B.find.folder('5');

    • Find an relate form entry by id or a string representing an id.

      Parameters

      • id: string | Id<Bluestep.Relate.Entry>

        Id or string representing an id or short id.

      • Optionalwritable: boolean

        Will the script be writing to the fields in this entry. Value is false when absent.

      Returns FormEntry

      const entry = B.findEntry(id, true);

      const entry = B.findEntry('1000002___5', true);

    • Find a [[Relate.FormMetaData]] by its [[Id.shortId]] or a full id as a string

      Parameters

      • id: string

        Value representing a full or short id of a [[Relate.FormMetaData]].

      Returns FormMetaData

      const form = B.find.formMetaData('5');

    • Find a [[Relate.MergeReportMetaData]] by its [[Id.shortId]] or short altid as a string

      Parameters

      • id: string

        Value representing a short id or short alt id of a [[MergeReportMetaData]].

      • lang: string

        js for bluestep.js; rs for RelateScript.

      Returns MergeReportMetaData

      B.out = B.find.mergeReport('FID_clientHeader', 'rs').mergeTag();

    • Find a [[Relate.MergeReportMetaData]] by its full id as a string

      Parameters

      • id: string

        Value representing a full id of a [[MergeReportMetaData]].

      Returns MergeReportMetaData

      B.out = B.find.mergeReport('530024__FID_clientHeader').mergeTag();

    • Find an [[Organization]] by its [[Id.shortId]] or a full id as a string

      Parameters

      • id: string

        Value representing a full or short id of an [[Organization]].

      Returns Organization

      const org = B.find.organization('5');

    • Find a [[Relate.QueryMetaData]] by its [[Id.shortId]] or a full id as a string

      Parameters

      • id: string

        Value representing a full or short id of a [[User]].

      Returns QueryMetaData

      const user = B.find.query('5');

    • Find a [[Relate.RecordContainer]] by its [[Id.shortId]] or a full id as a string

      Parameters

      • id: string

        Value representing a full or short id of a [[Relate.RecordContainer]].

      Returns RecordContainer

      const recordContainer = B.find.recordContainer('5');

    • Find a [[Relate.ReportMetaData]] by its [[Id.shortId]] or a full id as a string

      Parameters

      • id: string

        Value representing a full or short id of a [[ReportMetaData]].

      Returns ReportMetaData

      const report = B.find.report('5');

    • Find a [[SecurityGroup]] by its [[Id.shortId]] or a full id as a string

      Parameters

      • id: string

        Value representing a full or short id of a [[SecurityGroup]].

      Returns SecurityGroup

      const securityGroup = B.find.securityGroup('5');

    • Find a [[SecurityGroup]] by its formula id.

      Parameters

      • formulaId: string

        Formula Id of a SecurityGroup

      Returns SecurityGroup

      const securityGroup = B.findSecurityGroup(id);

    • Find a [[Unit]] by its [[Id.shortId]] or a full id as a string

      Parameters

      • id: string

        Value representing a full or short id of a [[Unit]].

      Returns Unit

      const unit = B.find.unit('5');

    • Find a [[User]] by its [[Id.shortId]] or a full id as a string

      Parameters

      • id: string

        Value representing a full or short id of a [[User]].

      Returns User

      const user = B.find.user('5');

    • Find a user by their usename.

      Parameters

      • username: string

        Username used for search

      Returns User

      const entry = B.findUser('johndoe');

    • Find a [[WebApplication]] by its [[Id.shortId]] or a full id as a string

      Parameters

      • id: string

        Value representing a full or short id of a [[WebApplication]].

      Returns WebApplication

      const webApp = B.find.webApplication('5');

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods