Class SetCredentialsResponse

SetCredentialsResponse

Builder to create a setCredentials() response for your script project.

function setCredentials(request) {
  var isValid = checkForValidCreds(request);

  if (isValid) {
    // store the creds somewhere.
  }

  return cc.newSetCredentialsResponse()
    .setIsValid(isValid)
    .build();
}

Methods

MethodReturn typeBrief description
build()ObjectValidates this object and returns it in the format needed by Data Studio.
printJson()StringPrints the JSON representation of this object.
setIsValid(isValid)SetCredentialsResponseSets the valid status of this SetCredentialsResponse.

Detailed documentation

build()

Validates this object and returns it in the format needed by Data Studio.

Return

Object — The validated SetCredentialsResponse object.


printJson()

Prints the JSON representation of this object. This is for debugging only.

Return

String


setIsValid(isValid)

Sets the valid status of this SetCredentialsResponse. Set to true if the credentials provided in the request were valid, false, otherwise.

Parameters

NameTypeDescription
isValidBooleanThe valid status to set.

Return

SetCredentialsResponse — This builder, for chaining.