NetworkLinkControl

Controls the behavior of files fetched by a <NetworkLink>.

minRefreshPeriod: Specified in seconds, <minRefreshPeriod> is the minimum allowed time between fetches of the file. This parameter allows servers to throttle fetches of a particular file and to tailor refresh rates to the expected rate of change to the data. For example, a user might set a link refresh to 5 seconds, but you could set your minimum refresh period to 3600 to limit refresh updates to once every hour.
maxSessionLength: Specified in seconds, <maxSessionLength> is the maximum amount of time for which the client NetworkLink can remain connected. The default value of -1 indicates not to terminate the session explicitly.
cookie: Use this element to append a string to the URL query on the next refresh of the network link. You can use this data in your script to provide more intelligent handling on the server side, including version querying and conditional file delivery.
message: You can deliver a pop-up message, such as usage guidelines for your network link. The message appears when the network link is first loaded into Google Earth, or when it is changed in the network link control.
linkName: You can control the name of the network link from the server, so that changes made to the name on the client side are overridden by the server.
linkDescription: You can control the description of the network link from the server, so that changes made to the description on the client side are overridden by the server.
linkSnippet: You can control the snippet for the network link from the server, so that changes made to the snippet on the client side are overridden by the server. <linkSnippet> has a maxLines attribute, an integer that specifies the maximum number of lines to display.
expires: You can specify a date/time at which the link should be refreshed. This specification takes effect only if the <refreshMode> in <Link> has a value of onExpire. See <refreshMode>
update: with <Update>, you can specify any number of Change, Create, and Delete tags for a .kml file or .kmz archive that has previously been loaded with a network link. See <Update>.
abstractView: a LookAt or a Camera

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new NetworkLinkControl(minRefreshPeriod: Double, maxSessionLength: Double, expires: String, update: Update)
new NetworkLinkControl(minRefreshPeriod: Double, maxSessionLength: Double)
new NetworkLinkControl(minRefreshPeriod: Option[Double] = None, maxSessionLength: Option[Double] = None, cookie: Option[String] = None, message: Option[String] = None, linkName: Option[String] = None, linkDescription: Option[String] = None, linkSnippet: Option[Snippet] = None, expires: Option[String] = None, update: Option[Update] = None, abstractView: Option[AbstractView] = None, networkLinkControlSimpleExtensionGroup: Seq[Any] = Nil, networkLinkControlObjectExtensionGroup: Seq[Any] = Nil)

minRefreshPeriod
Specified in seconds, <minRefreshPeriod> is the minimum allowed time between fetches of the file. This parameter allows servers to throttle fetches of a particular file and to tailor refresh rates to the expected rate of change to the data. For example, a user might set a link refresh to 5 seconds, but you could set your minimum refresh period to 3600 to limit refresh updates to once every hour.
maxSessionLength
Specified in seconds, <maxSessionLength> is the maximum amount of time for which the client NetworkLink can remain connected. The default value of -1 indicates not to terminate the session explicitly.
cookie
Use this element to append a string to the URL query on the next refresh of the network link. You can use this data in your script to provide more intelligent handling on the server side, including version querying and conditional file delivery.
message
You can deliver a pop-up message, such as usage guidelines for your network link. The message appears when the network link is first loaded into Google Earth, or when it is changed in the network link control.
linkName
You can control the name of the network link from the server, so that changes made to the name on the client side are overridden by the server.
linkDescription
You can control the description of the network link from the server, so that changes made to the description on the client side are overridden by the server.
linkSnippet
You can control the snippet for the network link from the server, so that changes made to the snippet on the client side are overridden by the server. <linkSnippet> has a maxLines attribute, an integer that specifies the maximum number of lines to display.
expires
You can specify a date/time at which the link should be refreshed. This specification takes effect only if the <refreshMode> in <Link> has a value of onExpire. See <refreshMode>
update
with <Update>, you can specify any number of Change, Create, and Delete tags for a .kml file or .kmz archive that has previously been loaded with a network link. See <Update>.
abstractView
a LookAt or a Camera

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val abstractView: Option[AbstractView]

a LookAt or a Camera
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val cookie: Option[String]

Use this element to append a string to the URL query on the next refresh of the network link.
Use this element to append a string to the URL query on the next refresh of the network link. You can use this data in your script to provide more intelligent handling on the server side, including version querying and conditional file delivery.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val expires: Option[String]

You can specify a date/time at which the link should be refreshed.
You can specify a date/time at which the link should be refreshed. This specification takes effect only if the <refreshMode> in <Link> has a value of onExpire. See <refreshMode>
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val linkDescription: Option[String]

You can control the description of the network link from the server, so that changes made to the description on the client side are overridden by the server.
val linkName: Option[String]

You can control the name of the network link from the server, so that changes made to the name on the client side are overridden by the server.
val linkSnippet: Option[Snippet]

You can control the snippet for the network link from the server, so that changes made to the snippet on the client side are overridden by the server.
You can control the snippet for the network link from the server, so that changes made to the snippet on the client side are overridden by the server. <linkSnippet> has a maxLines attribute, an integer that specifies the maximum number of lines to display.
val maxSessionLength: Option[Double]

Specified in seconds, <maxSessionLength> is the maximum amount of time for which the client NetworkLink can remain connected.
Specified in seconds, <maxSessionLength> is the maximum amount of time for which the client NetworkLink can remain connected. The default value of -1 indicates not to terminate the session explicitly.
val message: Option[String]

You can deliver a pop-up message, such as usage guidelines for your network link.
You can deliver a pop-up message, such as usage guidelines for your network link. The message appears when the network link is first loaded into Google Earth, or when it is changed in the network link control.
val minRefreshPeriod: Option[Double]

Specified in seconds, <minRefreshPeriod> is the minimum allowed time between fetches of the file.
Specified in seconds, <minRefreshPeriod> is the minimum allowed time between fetches of the file. This parameter allows servers to throttle fetches of a particular file and to tailor refresh rates to the expected rate of change to the data. For example, a user might set a link refresh to 5 seconds, but you could set your minimum refresh period to 3600 to limit refresh updates to once every hour.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val networkLinkControlObjectExtensionGroup: Seq[Any]
val networkLinkControlSimpleExtensionGroup: Seq[Any]
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val update: Option[Update]

with <Update>, you can specify any number of Change, Create, and Delete tags for a .kml file or .kmz archive that has previously been loaded with a network link.
with <Update>, you can specify any number of Change, Create, and Delete tags for a .kml file or .kmz archive that has previously been loaded with a network link. See <Update>.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package kml

Instance Constructors

new NetworkLinkControl(minRefreshPeriod: Double, maxSessionLength: Double, expires: String, update: Update)

new NetworkLinkControl(minRefreshPeriod: Double, maxSessionLength: Double)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val abstractView: Option[AbstractView]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val cookie: Option[String]

final def eq(arg0: AnyRef): Boolean

val expires: Option[String]

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val linkDescription: Option[String]

val linkName: Option[String]

val linkSnippet: Option[Snippet]

val maxSessionLength: Option[Double]

val message: Option[String]

val minRefreshPeriod: Option[Double]

final def ne(arg0: AnyRef): Boolean

val networkLinkControlObjectExtensionGroup: Seq[Any]

val networkLinkControlSimpleExtensionGroup: Seq[Any]

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

val update: Option[Update]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped