FaxResource Class


FaxResource Class

Represents a single Fax Resource on the Telephony Server.

Inheritance Hierarchy

SystemObject
  ClientObject
    VoiceElements.ClientRoutableResource
      VoiceElements.ClientFaxResource

Namespace: VoiceElements.Client
Assembly: VoiceElementsClient (in VoiceElementsClient.dll) Version: 8.6.1.1

Syntax

C++

Copy

public class FaxResource : RoutableResource

Public Class FaxResource
	Inherits RoutableResource

public ref class FaxResource : public RoutableResource

type FaxResource =  
    class
        inherit RoutableResource
    end

The FaxResource type exposes the following members.

Properties

	Name	Description
	CalledSubscriberId	The Subscriber ID (CSID) of the called party for the fax.
	Conference	Represents the Conference of which this resource is a member. (Inherited from RoutableResource.)
	ConferenceAttributes	Represents the Conference Attributes of a Conference to which this resource is a member. (Inherited from RoutableResource.)
	CoverPage	Gets or Sets the CoverPage file and path for the Fax.
	DeviceName	The unique name of this resource / device on the server. This is useful for following, logging a call or thread. (Inherited from RoutableResource.)
	EnableFaxStatusEvents	Enables or disables Fax Status Events
	FaxErrorCode	Returns the PhaseEStatus as a FaxErrorCode
	FaxMode	The Fax Mode for the last or next operation. This is a choice between Normal and T.38.
	FaxResult	The Fax Result of the last operation.
	HeaderText	Text to be transmitted at the top of each page of the Fax.
	Listeners	A list of Routable Resources which are currently listening to this resource. (Inherited from RoutableResource.)
	ListentingTo	A Routable Resources to which this resource is currently listening. (Inherited from RoutableResource.)
	PageCount	The count of pages for the last Fax sent or received.
	PhaseEStatus	Error condition information from the last Fax operation if applicable.
	TransmittingSubscriberId	The Subscriber ID (TSID) of the transmitting party for the fax used during sending.

Top

Methods

	Name	Description
	Dispose	This method forces a dispose of the Fax Resource object. Always do this in hang up handling to ensure clean up. (Overrides ClientObject.Dispose(Boolean).)
	Receive	Receives a fax and saves it into the specified file.
	RouteFull(TelephonyLinkInfo)	This overload is for Voice Elements Internal Use Only! To correctly route, use the Full Route Method. (Inherited from RoutableResource.)
	RouteFull(RoutableResource)	Completes a full route between two Routable Resources. Both channels then listen to each other. (Inherited from RoutableResource.)
	RouteHalf(TelephonyLinkInfo)	This overload is for Voice Elements Internal Use Only! To correctly route, use the Half Route Method. (Inherited from RoutableResource.)
	RouteHalf(RoutableResource)	Completes a half route between two Routable Resources. The channel calling this method listens to the one in the parameter, the second cannot hear. (Inherited from RoutableResource.)
	Send(String)	Sends the specified document as a fax from the specified file and path.
	Send(String)	Sends all of the the specified documents in an array as faxes.
	SetConferenceAGCLevels	Sets the levels for the AGC in conferencing. If all values are set to negatives, then the system wide AGC applies. (Inherited from RoutableResource.)
	SetConferenceECTailDelay	Sets the Echo Tail Delay in conferencing. (Inherited from RoutableResource.)
	SetConferenceFEGLevel	Sets the front end gain in conferencing. If set to 0, front end gain is turned off. (Inherited from RoutableResource.)
	Stop	Stops any current activity on the fax resource, such as a send or a receive.
	StopAllListeners	Forces all Routable Resources currently listening to this resource to stop. (Inherited from RoutableResource.)
	StopListener	Forces a apecific Routable Resource currently listening to this resource to stop. (Inherited from RoutableResource.)
	StopListening	Forces this resource to stop listening to all Routable Resources. (Inherited from RoutableResource.)

Top

Events

	Name	Description
	FaxStatus	This event fires at periodic intervals when sending or recieving faxes.

Top

Remarks

Documentation In Development

We are constantly adding features and new capabilities to The Voice Elements Platform. Therefore, our documentation of individual methods, properties and other elements is constantly being developed and improved. If you would like to know more about this element, please help us perfect our documentation and help you develop your application by doing one or more of the following:

Thank you for your continued support of Voice Elements.

Reference

VoiceElements.Client Namespace