All Implemented Interfaces:

app.rive.runtime.kotlin.core.RefCount
```
@OpenForTesting() 
public final class File
extends NativeObject
                    
```
Files are created in the rive editor.
This object has a counterpart in C++, which implements a lot of functionality. The base class's cppPointer keeps track of this relationship.
You can export these .riv files and load them up. Files can contain multiple artboards.
If the given file cannot be loaded this will throw a RiveException. The Rive File format is evolving, and while we attempt to keep backwards (and forwards) compatibility where possible, there are times when this is not possible.
The rive editor will always let you download your file in the latest runtime format.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`File.Enum`	The name and values of an enum, whether system or user defined.

Field Summary

Fields
Modifier and Type	Field	Description
`private final ReentrantLock`	`lock`
`private final Artboard`	`firstArtboard`
`private final Integer`	`artboardCount`
`private final List<String>`	`artboardNames`
`private final List<File.Enum>`	`enums`
`private final Integer`	`viewModelCount`
`private final RendererType`	`rendererType`
`private final Boolean`	`hasCppObject`
`private AtomicInteger`	`refs`
`private Long`	`cppPointer`
`private final List<RefCount>`	`dependencies`
`private final Integer`	`refCount`

Constructor Summary

Constructors
Constructor	Description
`File(ByteArray bytes, RendererType rendererType, FileAssetLoader fileAssetLoader)`

Method Summary

Modifier and Type	Method	Description
`final ReentrantLock`	`getLock()`
`final Artboard`	`getFirstArtboard()`
`final Integer`	`getArtboardCount()`
`final List<String>`	`getArtboardNames()`
`final List<File.Enum>`	`getEnums()`
`final Integer`	`getViewModelCount()`
`final RendererType`	`getRendererType()`
`final Boolean`	`getHasCppObject()`
`final AtomicInteger`	`getRefs()`
`final Unit`	`setRefs(AtomicInteger refs)`
`final Long`	`getCppPointer()`
`final Unit`	`setCppPointer(Long cppPointer)`
`final List<RefCount>`	`getDependencies()`
`Integer`	`getRefCount()`
`Unit`	`cppDelete(Long pointer)`
`final Artboard`	`artboard(String name)`	Get the artboard called name in the file.
`final Artboard`	`artboard(Integer index)`	Get the artboard at a given index in the File.
`final ViewModel`	`getViewModelByIndex(Integer viewModelIdx)`	Get the ViewModel definition from the file.
`final ViewModel`	`getViewModelByName(String viewModelName)`	Get the ViewModel definition from the file.
`final ViewModel`	`defaultViewModelForArtboard(Artboard artboard)`	Get the default ViewModel for an Artboard.
`Integer`	`release()`	Decrements the reference counter.

Methods inherited from class app.rive.runtime.kotlin.core.File
acquire
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

File

File(ByteArray bytes, RendererType rendererType, FileAssetLoader fileAssetLoader)

Method Detail
- getLock
```
 final ReentrantLock getLock()
```
- getFirstArtboard
```
 final Artboard getFirstArtboard()
```
- getArtboardCount
```
 final Integer getArtboardCount()
```
- getArtboardNames
```
 final List<String> getArtboardNames()
```
- getEnums
```
 final List<File.Enum> getEnums()
```
- getViewModelCount
```
 final Integer getViewModelCount()
```
- getRendererType
```
 final RendererType getRendererType()
```
- getHasCppObject
```
 final Boolean getHasCppObject()
```
- getRefs
```
 final AtomicInteger getRefs()
```
- setRefs
```
 final Unit setRefs(AtomicInteger refs)
```
- getCppPointer
```
 final Long getCppPointer()
```
- setCppPointer
```
 final Unit setCppPointer(Long cppPointer)
```
- getDependencies
```
 final List<RefCount> getDependencies()
```
- getRefCount
```
 Integer getRefCount()
```
- cppDelete
```
 Unit cppDelete(Long pointer)
```
- artboard
```
 final Artboard artboard(String name)
```
  Get the artboard called name in the file.
  If multiple Artboards have the same name it will return the first match.
- artboard
```
 final Artboard artboard(Integer index)
```
  Get the artboard at a given index in the File.
  This starts at 0.
- getViewModelByIndex
```
 final ViewModel getViewModelByIndex(Integer viewModelIdx)
```
  Get the ViewModel definition from the file.
  
  Parameters:
  
  viewModelIdx - The Rive file 0-based index of the ViewModel.
- getViewModelByName
```
 final ViewModel getViewModelByName(String viewModelName)
```
  Get the ViewModel definition from the file.
  
  Parameters:
  
  viewModelName - The Rive file name of the ViewModel.
- defaultViewModelForArtboard
```
 final ViewModel defaultViewModelForArtboard(Artboard artboard)
```
  Get the default ViewModel for an Artboard. Usually this will be the ViewModel intended for use with this artboard.
  
  Parameters:
  
  artboard - The artboard to get the default ViewModel for.
- release
```
 Integer release()
```
  Decrements the reference counter.

Class File

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class app.rive.runtime.kotlin.core.File

Methods inherited from class java.lang.Object

Constructor Detail

File

Method Detail

getLock

getFirstArtboard

getArtboardCount

getArtboardNames

getEnums

getViewModelCount

getRendererType

getHasCppObject

getRefs

setRefs

getCppPointer

setCppPointer

getDependencies

getRefCount

cppDelete

artboard

artboard

getViewModelByIndex

getViewModelByName

defaultViewModelForArtboard

release