JavascriptCallbackBehaviorAttribute Class

Reference

Definition

Namespace:: System.ServiceModel.Web

Assembly:: System.ServiceModel.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A contract behavior that allows you to set the URL query string parameter name to something other than the default "callback".

public ref class JavascriptCallbackBehaviorAttribute sealed : Attribute, System::ServiceModel::Description::IContractBehavior

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false)]
public sealed class JavascriptCallbackBehaviorAttribute : Attribute, System.ServiceModel.Description.IContractBehavior

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false)>]
type JavascriptCallbackBehaviorAttribute = class
    inherit Attribute
    interface IContractBehavior

Public NotInheritable Class JavascriptCallbackBehaviorAttribute
Inherits Attribute
Implements IContractBehavior

Inheritance: Object

Attribute
JavascriptCallbackBehaviorAttribute

Attributes: AttributeUsageAttribute

Implements: IContractBehavior

Remarks

JSONP is a mechanism used to enable cross-site, scripting support in Web browsers. It involves sending a request with a callback function name provided as a URL query string parameter value. The service returns a response with the usual JSON payload wrapped in the call to the provided callback function as if it were a line of executable code.

The following is an example of a URL used to call a service: http://baseAddress/Service/RESTService?callback=functionName. When invoked, the service responds with the following JSON.

functionName({ "root":"Something});

The JavascriptCallbackBehaviorAttribute allows developers to specify the name of the URL query string parameter to interpret as the callback parameter. The default value is "callback" (not case sensitive).

The following example shows how this attribute is applied to a service contract.

[ServiceContract]  
[JavascriptCallbackBehavior]  
public class Service1  
{  
    [OperationContract]  
    [WebGet(ResponseFormat=WebMessageFormat.Json)]  
    public string GetData()  
    {              
         // ...  
    }  
}

This attribute only applies when it marks a service contract type that is used with the WebHttpBinding and the CrossDomainScriptAccessEnabled property of the binding is set to true.

Constructors

JavascriptCallbackBehaviorAttribute()

Initializes a new instance of the JavascriptCallbackBehaviorAttribute class.

Properties

TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)
UrlParameterName	Gets or sets the URL query string parameter name to use for cross-domain script access.

Methods

AddBindingParameters(ContractDescription, ServiceEndpoint, BindingParameterCollection)	An implementation of the AddBindingParameters(ContractDescription, ServiceEndpoint, BindingParameterCollection) method.
ApplyClientBehavior(ContractDescription, ServiceEndpoint, ClientRuntime)	An implementation of the ApplyClientBehavior(ContractDescription, ServiceEndpoint, ClientRuntime) method.
ApplyDispatchBehavior(ContractDescription, ServiceEndpoint, DispatchRuntime)	An implementation of the ApplyDispatchBehavior(ContractDescription, ServiceEndpoint, DispatchRuntime) method.
Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)
Validate(ContractDescription, ServiceEndpoint)	An implementation of the Validate(ContractDescription, ServiceEndpoint) method.

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Provides access to properties and methods exposed by an object. (Inherited from Attribute)

Applies to

Share via