# Disable Component

# Usage

Sets the disabled flag to true on a component

# Syntax

webclient.disableComponent(payload: Object): Promise

# Arguments

Name	Type	Description
payload	object	The payload object passed to each call to the listener method. Must contain the number field as a string.

# Sample Javascript

import IpscapeWebClient from '@ipscape/web-client';

// Create a new instance of the IpSCAPE Web Client
const webClient = new IpscapeWebClient();

webclient.disableComponent({ name: 'people' }).then((eventData) => {
    if (eventData.success)
        console.log('component: disabled', eventData);
    else
        console.error('component: error', eventData.message);
});

# Response

This method returns a promise. The resolved response is returned in an object and contains the following:

Result

Example success Response

Returns this object if the API method call was invoked successfully, false otherwise.

{
    success: boolean;
    result: {
        message: string;
        timestamp: number;
    }
}