Interface ReplicatedStorage.Entry

  • Enclosing interface:
    ReplicatedStorage

    public static interface ReplicatedStorage.Entry

    Implemented by SLEE. Entry objects returned from the ReplicatedStorage facility are only valid within a single transaction.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      InputStream getInputStream()
      Get the value of the entry, as an input stream.
      ReplicatedStorage.Key getKey()
      Get the key that identifies this entry in the replicated storage
      byte[] getValue()
      Get the value of the entry, as a byte array.
      void remove()
      Convenience method to remove this entry from the ReplicatedStorage where it was created.
      void update​(byte[] newValue)
      Convenience method to update the entry in the ReplicatedStorage where it was created.
    • Method Detail

      • getKey

        ReplicatedStorage.Key getKey()

        Get the key that identifies this entry in the replicated storage

        Returns:
        the entry’s key.
      • getValue

        byte[] getValue()

        Get the value of the entry, as a byte array.

        Returns:
        a byte array.
      • getInputStream

        InputStream getInputStream()

        Get the value of the entry, as an input stream.

        Returns:
        an input stream.
      • remove

        void remove()
             throws ReplicatedStorageException

        Convenience method to remove this entry from the ReplicatedStorage where it was created. MUST be called in the same transaction context where this entry was created or retrieved.

        Throws:
        ReplicatedStorageException
      • update

        void update​(byte[] newValue)
             throws ReplicatedStorageException

        Convenience method to update the entry in the ReplicatedStorage where it was created. MUST be called in the same transaction context where this entry was created or retrieved.

        Parameters:
        newValue - the new value of the data to be stored in the entry.
        Throws:
        ReplicatedStorageException