Class FormElementLists

Hierarchy

  • default
    • FormElementLists

Constructors

constructor

Methods

createFormElementList deleteFormElementList searchFormElementLists updateFormElementList

Constructors

constructor

  • new FormElementLists(options): FormElementLists

  • Example

    import { FormElementLists } from '@oneblink/sdk'

    const options = {
      accessKey: '123455678901ABCDEFGHIJKL',
      secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
    }
    const formElementListsClient = new FormElementLists(options)

    Parameters

    Returns FormElementLists

Methods

createFormElementList

  • createFormElementList(newFormElementList): Promise<FormElementOptionSet>

  • Example

    const data = {
      name: 'my list',
      organisationId: 'abc123',
      environments: [
        {
          options: [
             {
               label: 'One'
               value: '1'
             },
             {
               label: 'Two'
               value: '2'
             }
          ]
          formsAppEnvironmentId: 1,
        },
      ],
      type: 'STATIC',
    }
    const list = await formElementListsClient.createFormElementList(data)
    // Use list here...

    Parameters

    Returns Promise<FormElementOptionSet>

deleteFormElementList

  • deleteFormElementList(id): Promise<void>

  • Example

    await formElementListsClient.deleteFormElementList(1)

    Parameters

    • id: number

      The id of the list to delete

    Returns Promise<void>

searchFormElementLists

updateFormElementList

  • updateFormElementList(list): Promise<FormElementOptionSet>

  • Example

    const data = {
      id: 1,
      name: 'my list',
      organisationId: 'abc123',
      environments: [
        {
          options: [
             {
               label: 'One'
               value: '1'
             },
             {
               label: 'Two'
               value: '2'
             },
             {
               label: 'Three'
               value: '2'
             },
          ]
          formsAppEnvironmentId: 1,
        },
      ],
      type: 'STATIC',
    }
    const list = await formElementListsClient.updateFormElementList(data)
    // Use list here...

    Parameters

    Returns Promise<FormElementOptionSet>

Settings

Member Visibility

Theme

On This Page