URL Scheme

    You can use URL schemes to run the LINE WORKS app and to perform the main features.

    1. Syntax

    The syntax of a custom URL scheme is as follows:

    lineworks://{host}/{path..}?version={scheme_version}?{parameter1=values1}&{parameter2=values2}...

    Host, Path and Parameter

    Pass the following items in your custom URL scheme.

    Item Description
    host Name of the service for which you want to perform features by using the custom URL scheme.

    ● default: LINE WORKS app
    ● message: Message
    ● calendar: Calendar
    ● contact: Contact
    ● drive: Drive
    ● home: Home
    ● mail: Mail
    ● more: View more
    path Defines the detailed feature in the service.
    version={schem_version} Custom URL scheme version

    ● 8: Supports App Version 2.1.3.
    ● 10: Supports App Version 2.2.1.
    ● 11: Supports App Version 2.3.1.
    {parametar1=values1} Defines information to be passed when you perform features with the URL scheme.

    2. URL Scheme Commands

    2.1. Run LINE WORKS app

    Runs the LINE WORKS app.

    run_lw_app

    URL Scheme

    Scheme Description
    lineworks://default?version={scheme_verion} Runs the LINE WORKS app.

    2.2. Run LINE WORKS app with opening a specific page

    Runs the LINE WORKS app to open a specific service tab.

    run_lw_app_with_opening_specific_page

    Scheme Description
    lineworks://calendar?version={scheme_verion} The LINE WORKS app is launched with the Calendar tab open.
    lineworks://contact?version={scheme_verion} The LINE WORKS app is launched with the Contact tab open.
    lineworks://drive?version={scheme_verion} The LINE WORKS app is launched with the Drive tab open.
    lineworks://home?version={scheme_verion} The LINE WORKS app is launched with the Home tab open.
    lineworks://mail?version={scheme_verion} The LINE WORKS app is launched with the Mail tab open.
    lineworks://message?version={scheme_verion} The LINE WORKS app is launched with the Message tab open..
    lineworks://more?version={scheme_verion} The LINE WORKS app is launched with the View more tab open.

    2.3. Send Message

    The LINE WORKS client sends messages to the chatroom with the specified recipients included.
    If one recipient is specified, a 1:1 chatroom is created and if multiple recipients are specified, a 1:N chatroom is created. If a chatroom with the specified recipient(s) already exists, the message is sent to the chatroom.

    send_message

    Scheme Description
    lineworks://message/send?version={scheme_verion}&message={message}&emailList={email_Address_List}&callbackMainYn={Y/N} Sends the message to the chatroom with the specified emailAddress list.

    2.3.1 Parameter

    Parameter Required Description Note
    version Y URL Scheme version
    message N Message to send
    emailList N List of user email addresses or DL addresses to receive messages (Add ; to separate them)
    callbackMainYn N Indicates whether the LINE WORKS app's main screen is displayed when the chatroom is closed.
    ● Y: The main screen is displayed (default).
    ● N: The main screen is not displayed.
    Android only

    2.3.2 Example

    Scheme Description
    lineworks://message/send?version={scheme_verion}&message={message}&emailList={emailAddressList} Sends {message} to the chatroom with {emailAddressList}.

    2.4. Write Schedule

    Creates an event entered by the LINE WORKS app.

    write_schedule

    Scheme Description
    lineworks://calendar/event/write?version={scheme_verion}&content={contents}``&scheduletype={schedule_type}&startdate={start_date}&invitees={invitees}``&memo={memo} Creates a {schedule_type} event which starts on {start_date} and is attended by {invitees}, with the subject of {contents}. {memo} is also included.

    2.4.1 Parameter

    Parameter Required Description Note
    version Y URL Scheme Version
    content N Event subject
    scheduletype N Event type

    ● 1: Anniversary
    ● 2: All day
    ● 3: Default event
    ● 4: Task
    startdate N Date and time

    ● yyyy-MM-dd: Date type
    ● yyyy-MM-ddTHH:mm:ss: Date and time type
    ● yyyy-MM-ddTHH:mm:ssZ: Date and time type
    For date and time types, an event for an hour from the current time is created.
    For the date and time type without Z, the local timezone is used.
    invitees N List of participants' email addresses (Add , to separate them)

    ● mailto:attendeetype:name:{name_value}"{attendeetype_value}:{mailto_value}
    "mailto" is required.
    attendeetype: Indicates whether the attendee is required for the event.
    (0: Required (default), 1: Optional)
    memo N Memo

    2.4.2 Example

    Scheme Description
    lineworks://calendar/write?version={scheme_verion}``&scheduletype={schedule_type}&content={contents}&startdate={start_date}&invitees={invitees} Creates a {schedule_type} event which starts on {start_date} and is attended by {invitees}, with the subject of {contents}.