setVisibility method

Future<DynamiteResponse<ProfileApiSetVisibilityResponseApplicationJson, void>> setVisibility({
  1. required String paramId,
  2. required String visibility,
  3. required String targetUserId,
  4. bool? oCSAPIRequest,
})

Update the visibility of a parameter.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • paramId ID of the parameter.
  • visibility New visibility.
  • targetUserId ID of the user.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Visibility updated successfully
  • 400: Updating visibility is not possible
  • 403: Not allowed to edit other users visibility
  • 404: User not found

See:

Implementation

Future<DynamiteResponse<ProfileApiSetVisibilityResponseApplicationJson, void>> setVisibility({
  required String paramId,
  required String visibility,
  required String targetUserId,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = setVisibilityRaw(
    paramId: paramId,
    visibility: visibility,
    targetUserId: targetUserId,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}