RelayContainer

RelayContainer is a higher order component that provides the ability to:

- Encode data dependencies using query fragments that are parameterized by routes and variables. - Manipulate variables via methods on this.props.relay. - Automatically subscribe to data changes. - Avoid unnecessary updates if data is unchanged. - Propagate the route via context (available on this.props.relay).

Annotations: @RawJSType() @native()

Linear Supertypes

Object, Any, AnyRef, Any

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def componentWillReceiveProps(nextProps: Object, nextContext: Object = ???): Unit
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def forceFetch(partialVariables: UndefOr[Variables] = js.undefined, callback: UndefOr[ComponentReadyStateChangeCallback] = js.undefined): Unit

Requests an update to variables.
Requests an update to variables. Unlike setVariables, this forces data to be fetched and written for the supplied variables. Any data that previously satisfied the queries will be overwritten.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getFragment(fragmentName: String, route: RelayQueryConfig = ???, variables: Variables = ???): RelayQueryFragment
def getFragmentError(fragmentReference: RelayFragmentReference, record: Object): UndefOr[Error]

Returns any error related to fetching data for a deferred fragment.
def getFragmentNames(): Array[String]
def getPendingTransactions(record: Object): UndefOr[Array[RelayMutationTransaction]]

Returns the pending mutation transactions affecting the given record.
def hasFragmentData(fragmentReference: RelayFragmentReference, record: Object): Boolean

Checks if data for a deferred fragment is ready.
Checks if data for a deferred fragment is ready. This method should *always* be called before rendering a child component whose fragment was deferred (unless that child can handle null or missing data).
def hasOptimisticUpdate(record: Object): Boolean

Determine if the supplied record reflects an optimistic update.
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

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

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
def render(): ReactElement
var route: RelayQueryConfig
def setVariables(partialVariables: UndefOr[Variables] = js.undefined, callback: UndefOr[ComponentReadyStateChangeCallback] = js.undefined): Unit

Requests an update to variables.
Requests an update to variables. This primes the cache for the new variables and notifies the caller of changes via the callback. As data becomes ready, the component will be updated.
def shouldComponentUpdate(nextProps: Object, nextState: Any, nextContext: Any): Boolean
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
def valueOf(): Any

Definition Classes
Object
var variables: Variables
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 Docs: object RelayContainer | package container

trait RelayContainer[P <: RelayComponentProps, S] extends Object

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def componentWillReceiveProps(nextProps: Object, nextContext: Object = ???): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def forceFetch(partialVariables: UndefOr[Variables] = js.undefined, callback: UndefOr[ComponentReadyStateChangeCallback] = js.undefined): Unit

final def getClass(): Class[_]

def getFragment(fragmentName: String, route: RelayQueryConfig = ???, variables: Variables = ???): RelayQueryFragment

def getFragmentError(fragmentReference: RelayFragmentReference, record: Object): UndefOr[Error]

def getFragmentNames(): Array[String]

def getPendingTransactions(record: Object): UndefOr[Array[RelayMutationTransaction]]

def hasFragmentData(fragmentReference: RelayFragmentReference, record: Object): Boolean

def hasOptimisticUpdate(record: Object): Boolean

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def propertyIsEnumerable(v: String): Boolean

def render(): ReactElement

var route: RelayQueryConfig

def setVariables(partialVariables: UndefOr[Variables] = js.undefined, callback: UndefOr[ComponentReadyStateChangeCallback] = js.undefined): Unit

def shouldComponentUpdate(nextProps: Object, nextState: Any, nextContext: Any): Boolean

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

def toLocaleString(): String

def toString(): String

def valueOf(): Any

var variables: Variables

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped