SIP .NET Class Library
SIP .NET Class Library
SIP .NET
Independentsoft.Sip.Methods
Refer Class
Refer Constructor
Refer Properties
Refer Methods

# Refer Class

The Refer class represents REFER method. The REFER method is used by a client to request another client to access a URI or URL resource. The resource is identified by a URI or URL in the required Refer-To header field. A REFER request can be sent either inside or outside an existing dialog.
Inheritance Hierarchy
System
Object
Independentsoft.Sip
Request
Independentsoft.Sip.Methods
Refer

Namespace: Independentsoft.Sip.Methods
Assembly: Independentsoft.Sip (in Independentsoft.Sip.dll) Version: 1.0.700.17927
Syntax
C#
VB
Copy

    public class Refer : Request

    Public Class Refer
    	Inherits Request

The Refer type exposes the following members.

Constructors

| Name | Description
--- | --- | ---
| Refer | Initializes a new instance of the Refer class.
| Refer(Dialog) | Initializes a new instance of the Refer class from the specified dialog.
| Refer(Response) | Initializes a new instance of the Refer class from the specified response.

Top
Properties

| Name | Description
--- | --- | ---
| Accept | Gets or sets Accept header field. The Accept header field is used to indicate acceptable message Internet media types in the request body. The header field describes media types using the format type/sub-type commonly used in the Internet. If not present, the assumed acceptable request body format is application/sdp. The wildcard "*" can be used to specify all subtypes.
| AcceptEncoding | Gets or sets Accept-Encoding header field. The Accept-Encoding header field, is used to specify acceptable request body encoding schemes. If not included, the assumed encoding will be text/plain.
| AcceptLanguage | Gets or sets Accept-Language header field. The Accept-Language header field, is used in requests to indicate the preferred languages for reason phrases or session descriptions in the request body. The rules for ordering the languages is based on the "q" parameter.
| Allow | Gets or sets Allow header field. The Allow header field lists the set of methods supported by the client.
| Body | Gets or sets the request body. (Inherited from Request.)
| Branch | Sets or gets branch parameter in Via header. (Inherited from Request.)
| CallID | Gets or sets Call-ID header field. The Call-ID header field is mandatory in all requests. It is used to uniquely identify a call between two clients. If is not set then the SipClient will set this header. (Inherited from Request.)
| Contact | Gets or sets Contact header field. The Contact header field is used to convey a URI that identifies the request originator.
| ContentDisposition | Gets or sets Content-Disposition header field. The Content-Disposition header field is used to describe the function of a request body.
| ContentEncoding | Gets or sets Content-Encoding header field. The Content-Encoding header field is used as a modifier to the "media-type". When present, its value indicates what additional content codings have been applied to the request body, and thus what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type header field.
| ContentLanguage | Gets or sets Content-Language header field. The Content-Language header field is used to indicate the language of a request body. It contains a language tag, which identifies the language.
| ContentLength | Gets o sets Content-Length header field. The Content-Length header field indicates the size of the request body. If no body is present in a request, then the Content-Length header field value must be zero. (Inherited from Request.)
| ContentType | Gets or sets Content-Type header field. The Content-Type header field is used to specify the Internet media type in the request body. Media types have the familiar form type/sub-type. If this header field is not present, application/sdp is assumed. (Inherited from Request.)
| CSeq | Gets CSeq header field. The CSeq header field is a required header field in every request. The CSeq header field contains a number that increases for each request. Usually, it increases by 1 for each new request, with the exception of CANCEL and ACK requests, which use the CSeq number of the INVITE request to which it refers. (Inherited from Request.)
| Date | Gets or sets Date header field. The Date header field is used to convey the date when the request is sent. (Inherited from Request.)
| ErrorInfo | Gets or sets Error-Info header field. The Error-Info header field provides a pointer to additional information about the error status response.
| Expires | Gets or sets Expires header field. The Expires header field indicates the time interval in which the request is valid. The value of this header field is number of seconds between 0 and 4294967295.
| From | Gets or sets From header field. The From header field is a required header field that indicates the originator of the request. (Inherited from Request.)
| Header | Gets the request header. (Inherited from Request.)
| MaxForwards | Gets or sets Max-Forwards header field. The Max-Forwards header field is used to indicate the maximum number of hops that a the request may take. The value of the header field is decremented by each proxy that forwards the request. If is not set then the SipClient will set this header. (Inherited from Request.)
| Method | Gets the request method. (Inherited from Request.)
| Organization | Gets or sets Organization header field. The Organization header field is used to indicate the organization to which the originator of the request belongs.
| ProxyRequire | Gets or sets Proxy-Require header field. The Proxy-Require header field is used to list features and extensions that a client requires a proxy to support in order to process the request.
| RecordRoute | Gets or sets Record-Route header field. The Record-Route header field is used to force routing through a proxy for all subsequent requests in a session between two clients.
| ReferredBy | Gets or sets Referred-By header field. The Referred-By header field provides the recipient of a triggered request information that the request was generated as a result of a REFER and the originator of the REFER.
| ReferTo | Gets or sets Refer-To header field. The Refer-To header contains the URI that is being referenced.
| Require | Gets Require header field. The Require header field is used to tell the client about options that the sender expects the client to support in order to process the request. The Require header field contains a list of option tags. Each option tag defines a SIP extension that must be understood to process the request. Frequently, this is used to indicate that a specific set of extension header fields need to be understood.
| Route | Gets Route header field. The Route header field is used to provide routing information for requests.
| Server | Gets Server header field. The Server header field contains information about the software used by the server to handle the request.
| SessionDescription | Returns the request body as SessionDescription if Content-Type is "application/sdp", otherwise returns null. Sets request body and sets Content-Type as "application/sdp". (Inherited from Request.)
| Supported | Gets or sets Supported header field. The Supported header field enumerates all the extensions supported by the client or server.
| Timestamp | Gets or sets Timestamp header field. The Timestamp header field describes when the client sent the request to the server. The time format is not specified.
| To | Gets or sets To header field. The To header field is a required header field in every request used to indicate the recipient of the request. (Inherited from Request.)
| Unsupported | Gets Unsupported header field. The Unsupported header field lists the features not supported by the server.
| Uri | Gets or sets request URI. It indicates the user or service to which this request is being addressed. (Inherited from Request.)
| Via | Gets or sets Via header field. The Via header field indicates the path taken by the request so far and indicates the path that should be followed in routing responses. The "branch" parameter in the Via header field values serves as a transaction identifier, and is used by proxies to detect loops. The Via header field value contains the transport protocol used to send the message, the client's host name or network address, and possibly the port number at which it wishes to receive responses. The Via header field value can also contain parameters such as "maddr", "ttl", "received" and "branch". (Inherited from Request.)
| Warning | Gets Warning header field. The Warning header field is used to carry additional information about the status of a request or response. The warning text should be in a natural language that is most likely to be intelligible to the human user receiving the response.

Top
Methods

| Name | Description
--- | --- | ---
| Equals | (Inherited from Object.)
| Finalize | (Inherited from Object.)
| GetHashCode | (Inherited from Object.)
| GetType | (Inherited from Object.)
| MemberwiseClone | (Inherited from Object.)
| ToString | Converts the value of this instance to its equivalent string representation. (Inherited from Request.)

Top
See Also

#### Reference

Independentsoft.Sip.Methods Namespace

Copyright 2023 Independentsoft

Send comments on this topic to support@independentsoft.de