ServiceKnownTypeAttribute Class
TOC
Collapse the table of content
Expand the table of content

ServiceKnownTypeAttribute Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Specifies known types to be used by a service when serializing or deserializing.

System.Object
  System.Attribute
    System.ServiceModel.ServiceKnownTypeAttribute

Namespace:  System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Interface|AttributeTargets.Method, Inherited = true, 
	AllowMultiple = true)]
public sealed class ServiceKnownTypeAttribute : Attribute

The ServiceKnownTypeAttribute type exposes the following members.

  NameDescription
Public methodServiceKnownTypeAttribute(String)Initializes a new instance of the ServiceKnownTypeAttribute class and specifies the name of a method that returns the known types.
Public methodServiceKnownTypeAttribute(Type)Initializes a new instance of the ServiceKnownTypeAttribute class with the specified known type.
Public methodServiceKnownTypeAttribute(String, Type)Initializes a new instance of the ServiceKnownTypeAttribute class with the name of a method that returns the known types and the type that contains the method (or methods) that returns the known types.
Top

  NameDescription
Public propertyDeclaringTypeGets the type that contains the methods that return the known types.
Public propertyMethodNameGets the name of a method that returns the collection of known types.
Public propertyTypeThe known type that can be included in an object graph.
Top

  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The ServiceKnownTypeAttribute is intended for use when creating Windows Phone service contracts (interfaces that define the service and its methods). The known types are types that may be present in an object graph when serialization or deserialization occurs.

To use the MethodName property, create a class that contains a method (or methods) that returns an array of types (each being a known type). When applying the attribute, set the methodName to the name of a method that returns the list of types and set the declaringType to the type that contains the method. The method must return a type that implements the IEnumerable<T> interface. The method must also include a parameter of type ICustomAttributeProvider.

You can also apply the attribute several times to an interface, class, or method, each time specifying a new known type.

NoteNote:

You can use the word ServiceKnownType in your Microsoft Visual Basic or C# code instead of the longer ServiceKnownTypeAttribute.

Capabilities

If you use this API in your app, you must specify the following capabilities in the app manifest. Otherwise, your app might not work correctly or it might exit unexpectedly.

ID_CAP_NETWORKING

Windows Phone 8, Windows Phone OS 7.1

For more info, see App capabilities and hardware requirements for Windows Phone 8.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2017 Microsoft