SchemaDesignerServices.ToggleFavoriteAvailability Method

SchemaDesignerServicesToggleFavoriteAvailability Method

Ingeniux CMS Web Services API

Toggles whether the Schema Field Favorite entry is available to everybody, or only the creator.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<SchemaPublicSetRequest> ToggleFavoriteAvailability(
	SchemaPublicSetRequest data
)

Public Function ToggleFavoriteAvailability ( 
	data As SchemaPublicSetRequest
) As XHRServiceResponseGeneric(Of SchemaPublicSetRequest)

public:
virtual XHRServiceResponseGeneric<SchemaPublicSetRequest^>^ ToggleFavoriteAvailability(
	SchemaPublicSetRequest^ data
) sealed

abstract ToggleFavoriteAvailability : 
        data : SchemaPublicSetRequest -> XHRServiceResponseGeneric<SchemaPublicSetRequest> 
override ToggleFavoriteAvailability : 
        data : SchemaPublicSetRequest -> XHRServiceResponseGeneric<SchemaPublicSetRequest>

Parameters

data

Type: SchemaPublicSetRequest

Information on the Schema Field Favorite entry to toggle availability one

Examples

Sample JSON input

JavaScript

Copy

{
    "data": {
        "FavoriteID": "SchemaFieldFavorites/33",
        "ToBePublic": true
    }
}

Return Value

Type: XHRServiceResponseGenericSchemaPublicSetRequest

The input data if toggling is successful. Error status if the Schema Field Favorite entry doesn't exist.

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "FavoriteID": "SchemaFieldFavorites\/33",
        "ToBePublic": true
    }
}

Reference

SchemaDesignerServices Class

IngeniuxCMService Namespace